Documentation policy #5
Description
We should think about the way we write documentation, and the way we store it. As I see it, there are 2 ways of documenting a step by step (management) technique. The first way is a working documentation, which is a very comprehensive way of documenting the thought process and alternative scenarios used to get the final result. The other way is a reporting documentation which displays only results of important steps to present the result of the technique.
Example:
Let's say we are documenting a strategy for implementing a business goal. Working documentation would contain multiple strategies, their analysis and the process and explanation of why the result strategy was selected. Reporting documentation would only show that the certain business goal has a strategy for its execution.
There is also a question of the documentation storage. As the team grows larger, so will the need for collaboration. Tools made for collaboration, like google drive, might be more suitable for working documentation, which might require collaboration. Tools like markdown might be more suitable for reporting documentation, which would have focus on clarity of presentation.