Process Documentation Standards: Difference between revisions

From Open Source Ecology
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
To document a Process, document all of the following:
From the OSE perspective, we are setting up processes that are simple and absolutely transparent. Our goal, wherever possible - is to make a process so transparent such that the entire world can observe the outcome of the process, who is doing it, by what standards (execution procedure) tahTo document a Process, document all of the following:


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


Then technical details:
Then technical details:
Line 13: Line 11:
#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?
#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?
#Execution - Step by step procedure for executing process
#Execution - Step by step procedure for executing process
#
#Documentation - What is the process by which anyone in the world can

Revision as of 14:49, 15 October 2012

From the OSE perspective, we are setting up processes that are simple and absolutely transparent. Our goal, wherever possible - is to make a process so transparent such that the entire world can observe the outcome of the process, who is doing it, by what standards (execution procedure) tahTo 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? How does the process promote transparent operation, openness, and sound governance?
  3. Who? - Who is responsible/accountable/consulted/informed about the process? Use RACI.
  4. 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
  4. Documentation - What is the process by which anyone in the world can