Process Documentation Standards

From Open Source Ecology
Revision as of 14:46, 15 October 2012 by Marcin (talk | contribs)
Jump to navigation Jump to search

To document a Process, document all of the following:

  1. What? Brief description of process and its purpose.
  2. Why? How does process help streamline operations? What efforts does it save?
  3. Who? - Who is responsible/accountable/consulted/informed about the process? Use RACI.
  4. How? - How does the process promote transparent operation, openness, and sound governance?
  5. When? - When is this process executed (day/time, frequency)


Then technical details:

  1. Time Requirements - when executed effectively, how long should this process take per day/week/month?
  2. Links - What are all the relevant links to the working substance, documentation database, source, list, account information, etc. that allows somebody to execute the process?
  3. Execution - Step by step procedure for executing process