Any plan mustI keep six honest serving men
(They taught me all I knew);
Their names are What, and Why and When;
and How and Where and Who.– Rudyard Kipling (1865-1936).
- Set out the objective - the "What".
- Explain the reason - the "Why".
- Specify the steps that are to be executed - the "How".
- Specify time sequence for execution - the "When".
- Specify the place, or the objects, where, or on which, the steps are to be completed - the "Where".
- Specify the persons responsible for the execution of the steps- the "Who".
Come to think of it, source code documentation too, with the possible exception of #6, should have the same information.
No comments:
Post a Comment