Project

General

Profile

UpdatingDocuments » History » Version 1

Tunnell, Christopher, 04 October 2010 13:34

1 1 Tunnell, Christopher
h1. Steps to Updating Documentation
2 1 Tunnell, Christopher
3 1 Tunnell, Christopher
h2. Requester: Create a 'feature' request
4 1 Tunnell, Christopher
5 1 Tunnell, Christopher
From this site (or anywhere in the operations area), click "New Issue":http://micewww.pp.rl.ac.uk:8080/projects/operations/issues/new from the above tabs.  In the description, either describe what documentation (or update) is requested.
6 1 Tunnell, Christopher
7 1 Tunnell, Christopher
h2. MOM: If necessary, assign tasks to somebody
8 1 Tunnell, Christopher
9 1 Tunnell, Christopher
If necessary, as in the case of a request to update documentation instead of somebody posting an update, the MOM should assign the task to whoever is responsible for that system.
10 1 Tunnell, Christopher
11 1 Tunnell, Christopher
h2.  Documenter:  Update documentation
12 1 Tunnell, Christopher
13 1 Tunnell, Christopher
The documenter should attach the documentation as a pdf and also include the source file (for example, .doc for Microsoft Word) to the issue then assign the task back to the MOM.
14 1 Tunnell, Christopher
15 1 Tunnell, Christopher
h2.  MOM: Review documentation
16 1 Tunnell, Christopher
17 1 Tunnell, Christopher
The MOM should review the update to make sure it's worth uploading.  If so, the MOM should add the new version to the document repository in the operation's section of this site.