How to write good documentation
How to write good documentation
zeroheight.comIshaan Gupta • How to close the project management gap with Slite & Linear
Going back to Thich Nhat Hanh, I believe that writing is part of every design. If you can clearly define what you’re making and articulate its value, the steps to bring it out into the world will go much faster. It’s easy to put pixels together when you’ve already made decisions. And since we work across systems and borders, there’s no better way t... See more
Matt Felten • Words as Material
Some companies think the answer to this is to try to document the system to the degree that everything is captured somehow in a way that members of the organization can all go to get the same sorts of answers for which they use the principal designer, principal product manager, and software architect.
Marty Cagan • INSPIRED: How to Create Tech Products Customers Love (Silicon Valley Product Group)
Document as you go, and only as needed. When you bake the documentation into your process, you only write documentation that is relevant and useful. Build cross-functional teams to break down silos, so that no individual or department can become a process or information bottleneck.
Chris Sims • The Elements of Scrum
The points I failed to grasp were that by not writing documentation:
- you’re shutting the door for others to work on the project
- your business is much more valuable when well-documented, as it’s far more attractive to buy
- documented processes help you save time and identify where things can be automated.