Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Teams
, (opens new window)

Appfire Comala Workflows Exchange
Results will update as you type.
  • Overview
    • Content Review Workflow
    • Simple approval workflow
    • Simple Space Publishing Workflow
    • Technical Documentation Workflow
    • Quality Management System Workflow
    • Editor and staff approval workflow
    • Scroll Versions documentation workflow
    • Remote Publishing Workflow
    • Lightweight Requirements Management workflow
    • Content Expiry Workflow
    • Hierarchy Review Workflow
    • FAQ Creation Workflow
    • Simple approval workflow 3.1
    • Editor and staff approval workflow 3.1
    • Content Review Workflow 3.1
    • Sample Document Management workflow
  • Repository Model
  • Categories
    You‘re viewing this with anonymous access, so some content might be blocked.
    /
    Technical Documentation Workflow
    Updated Jan 29, 2024

    Technical Documentation Workflow

    Importing workflows

    Find out how to Import Workflows

    Technical Document Management workflow

    requires v3.0.2+

    com.comalatech.workflow.repository.categories.label: Technical Documentation

    -

    Simple tech docs review workflow

    • Pending pages are restricted from read only viewing and will expire if not approved within the specified period of time

    • pages approved within the set time are Published and visible to all users


    Technical Documentation Workflow Markup

    {workflow:name=Technical Documentation Workflow} {description} Simple tech docs review workflow, pending pages are restricted from read only viewing and will expire if not approved within the specified period of time, pages approved within the set time are published and visible to all users. {description} {workflowparameter:Document Editors|description=Only members of this users group can view pending documents|type=group} confluence-users {workflowparameter} {workflowparameter:Pending Expiration|description=If a page stays in 'For review' for this period of time, then the state will be changed to 'Expired'|type=duration} P10D {workflowparameter} {state:Pending|submit=For review|taskable=true} {state} {state:For review|approved=Published|rejected=Pending|expired=Expired|taskable=true|hideselection=true|duedate=@Pending Expiration@} {approval:Publish|assignable=true} {state} {state:Published|final=true|updated=For review} {state} {state:On hold|submit=For review|hidefrompath=true} {state} {state:Expired|hidefrompath=true} {state} {trigger:statechanged|state=Pending|initial=true} {add-restriction:type=View|group=@Document Editors@} {trigger} {trigger:statechanged|state=Published} {remove-restriction:type=View} {trigger} {trigger:statechanged|state=On hold} {add-restriction:type=View|group=@Document Editors@} {trigger} {trigger:taskassigned} {send-email:user=<at:var at:name="assignee" />|subject=<at:var at:name="task" /> has been assigned to you} Task <at:var at:name="task" /> on <at:var at:name="page" /> has been assigned to you by [~<at:var at:name="user" />]. {quote}<at:var at:name="comment" />{quote} {pageactivity} {send-email} {trigger} {workflow}

     In later versions of Comala Document Management variables in the following syntax <at:var at:name="page" /> can simply be replaced by the name of the value reference enclosed in @ symbols for example @page@

    Technical documentation process

    Learn more

    • if a Published page is updated, then it is sent for review again

    • read-only users only have access to the content version created on the last transition to the Published state

    • if pages for review are not reviewed within a set period of time, content transitions to the Expired state

    • published pages can be put on hold to be hidden from the public, but will not be required to undergo content review and approval

    • the users assigned as page editors and the expiration period are configurable as workflow parameter values

    {"serverDuration": 13, "requestCorrelationId": "6ba2a5184681460bacd5e6ff24b9f920"}