frontend

What Makes Developer Documentation Useful

Useful developer documentation answers a question somebody is likely to have. How do I run this? Where does this value come from? What needs to happen before I can release it?

I prefer a working example and a short explanation over a long introduction. Searchable headings help too. If a page needs constant verbal correction from the team, the next improvement is probably to update that page rather than write another one.