The Documentation Status Field
Used by the Documentation team only, the Documentation Status field defines where the content for that JIRA ticket is in the workflow.
The Documentation Status field contains the following values:
-
Not Started—Default value. No work has been done on the ticket except for initial assignment in the Writer Assigned field.
-
Not Required—No documentation is required on the ticket.
-
In Process—Technical writer researches and writes draft content.
-
Review—PM/Dev is reviewing content.
-
Approved—Content has been approved by PM. TW adds content to Flare project and builds on dev site in Jenkins.
-
Peer Review—Technical Writer asks for peer review of content available on the dev sites.
-
Doc Done—Doc is complete, pushed to prod and ready for customers to use.
Assign Ticket and Set Documentation Status
The Writer Assigned and Documentation Status fields must be complete for all tickets.
Technical Writers review tickets when they are added to the board and assign the tickets as appropriate, either to themselves or other team members. Be sure to add yourself as the Writer Assigned for all tickets in the missions to which you are assigned.
To assign a writer:
-
Click the Edit button on the ticket.
-
Select the writer in the Writer Assigned list box.
-
Click Save.
