...
Unit: Web Maintenance Team
Date last updated: 03/01/2017 Sept. 2019
Date of next review: September 20192020
...
Guidelines for Procedure Writers
New and Extensively Revised Procedures
Updates and Minor Revisions
Administrative Issues
LTS Procedures Team
...
- Procedure writers should consult Guidelines for Procedure Writers in the section Section A (above) before beginning a new procedure or an extensive revision of an existing procedure.
- A new procedure or an extensive revision of an existing procedure should be sent to LTSHeads for review.If the writer is a member of the LTSHeads group, he/she should distribute copies of the completed draft to other members of that group for review. If the writer is not a member of the LTSHeads group, he/she should forward the draft to a LTSHeads member (e.g. his/her supervisor), who will see that it gets distributed. The distribution can be accomplished by sending a WORD document as an email attachment to LTSHeads-L.
- LTS Heads review the draft and provide feedback via e-mail (1-2 weeks).
- Upon approval by the LTSHeads, the writer incorporates any recommended changes (1 week).
- The writer forwards the final version to the Documentation Coordinator, who will see that it is added to the LTS Procedures pages in Confluence, and then announce the availability of the online version of the procedure by posting a note to LTS-L.
...
- Updates and minor revisions to existing procedures can be handled in a more streamlined fashion. These are changes which comprise no more than one or two paragraphs of new text or which consist essentially of corrections to, or short replacement of existing text, with no structural changes to the procedure as a whole. When in doubt about whether a revision is major or minor, procedure writers should consult with the Documentation Coordinator before proceeding.
- After ensuring that all interested parties have signed off on the update or revision (this may or may not involve soliciting input from LTSHeads), the writer should give a paper copy of the procedure to the Web Documentation Coordinator with changes and/or additons additions to text clearly annotated. If appropriate, replacement text can be submitted to the Documentation Coordinator in an email message.
- If the procedure Keeper prefers to make his or her own changes to procedures in Confluence, the "date updated" date should be changed in the "header" of the procedure, and as appropriate, the date of next review should also be changed. The procedure keeper should notify the Documentation Coordinator that annual review and/or revisions have been made so that the maintenance team's spreadsheet (see D #4 below) is kept current.
- The procedure writer or Web Documentation Coordinator will announce the change(s) on LTS-L.
...