DOCUMENTATION

A PRACTICAL METHODOLOGY FOR DOCUMENTATION

 
  The methodology we present here is based on the work of several authors and has been tried by different projects and institutions, who thus contributed to its development. The starting point is the selection of a project carried out by a team or group of persons, followed by three stages: setting the boundaries of the project to be documented, describing the experiences and achievements, and the critical analysis. The idea is to organise the information and the opinions of those involved in the project through a set of charts, which are continuously improved on, adding the contributions of those interested. To have an “organised” set of information makes it easy to determine if it is complete or not. It also facilitates the analysis, an essential step towards the identification of key learning points.

   
 

FIRST THINGS FIRST

         
  Having decided to start a documentation process, it is necessary to clarify some of the details involved. Who will participate in the process? Who will coordinate it? This is all considered here.
 

SETTING THE BOUNDARIES

           
  The idea is to select the project we are interested in documenting and then specify the main items that must be taken into account, and those that can be set aside.

 

DESCRIBING OUR EXPERIENCE

           
  In the second stage we focus on and describe the project being docu-mented, identifying the activities and achievements during the period of time chosen. At this stage we will describe everything that was done and achieved, including unexpected results, difficulties faced, and results or targets that were not reached.
 

THE ANALYSIS

           
  To enable us to learn from the project as a whole, and make the step from a pure description to a documentation process, we move onto the most important stage: the analysis. This is when the synthesis and critical over-view of the project is done, assessing the practices involved, and looking at which objectives were achieved.
 

WRITING UP THE DOCUMENT

           
  In this last stage, the aim is to present the results of the documentation process in an easily accessible manner which can reach those who may benefit from it directly. The usual objective is to publish a document of some format and in this way present and share the generated knowledge.
 
 
     
Comments:
Posted by: KPODONOU Hector heckpo at yahoo.fr (2007-02-21, 14:30)
Heureux de decouvrir la methodologie de documentation. Veuillez bien le traduire en français pour les francophones. Merci
Posted by: Swaminathan,C. (2006-11-09, 09:54)
After Analysis stage we have have one more stage before documentation that is "Objective setting for documentation". Here as we have analysed fully before documenting we have to set our objectives for documenting based on analysis. One nee not write all the analysis in the document. While documenting we have to also keep in mind the reader/audience of the document.
Posted by: swaminathan,C. (2006-11-09, 09:50)
After analysis stage we have to clearly prioritize the objective of documentation . While doing it we have to keep in our mind the audience for teh document. This stage can be clalled as Objective setting for documentation

Add a comment