If you're really short on time, here are some highlights:
- The fundamental issue is communication, not documentation.
- Agilists write documentation if that's the best way to achieve the relevant goals, but there often proves to be better ways to achieve those goals than writing static documentation.
- Document stable things, not speculative things.
- Take an evolutionary approach to documentation development, seeking and then acting on feedback on a regular basis.
- Prefer executable work products such as customer tests and developer tests over static work products such as plain old documentation (POD).
- You should understand the total cost of ownership (TCO) for a document, and someone must explicitly choose to make that investment.
- Well-written documentation supports organizational memory effectively, but is a poor way to communicate during a project.
- Documentation should be concise: overviews/roadmaps are generally preferred over detailed documentation.
- With high quality source code and a test suite to back it up you need a lot less system documentation.
- The benefit of having documentation must be greater than the cost of creating and maintaining it.
- Ask whether you NEED the documentation, not whether you want it.
- The investment in system documentation is a business decision, not a technical one.
1 comment:
I will add your blog to my list. Congratulations for your works!!
Post a Comment