Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. 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.
  2. 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 to text clearly annotated. If appropriate, replacement text can be submitted to the Documentation Coordinator in an email message.
  3. 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.  
  4. The procedure writer or Web Documentation Coordinator will announce the change(s) on LTS-L.

...