4 ms·
1. Start by understanding that this is a primarily social problem. Techniques like documentation or microservices are only that: techniques. The real goal is cl
by afarrell 5y ago
1. Start by understanding that this is a primarily social problem. Techniques like documentation or microservices are only that: techniques. The real goal is clear communication by any means necessary.
2. Make it easy to see from a document when it has gone out-of-date and whom to ask about it. If you expect a document to stay up-to-date, make sure someone has the capacity to pay attention to to and answer questions.
3. Less, but better. Actively encourage the process of pruning docs and putting them in history so that what remains stays trusted.
4. Start with Why. The most important thing to document is why things are. Why teams exist. Why projects exist.
5. Don’t assume that everyone has the context to write or maintain every document. If an individual is trying to create clarity on the organization’s top-level goals... then something deeper is broken.
6. Docs are best written as a pair-programming exercise between a novice and a senior.