I'm moving into documentation writing and have a chance to redesign our docs on a new platform. What examples are easy to use, and what should I pay attention to in their navigation, layout, or examples?
What technical docs are worth studying for a redesign?
Asked by
READY.set.maybe
Answers
MDN is a good place to start. Look at how its navigation makes related topics easy to find, and how examples sit alongside explanations. The examples are generally easy to follow without losing sight of the reference material.
Reply to this answer
Java documentation is worth a look for consistency and directness. Compare a few reference pages and see how a predictable structure helps when you're looking up details rather than reading straight through.
Reply to this answer
Check out the best practices page in the Godot engine contribution guide. It's a useful example of a focused page with pictures and a manageable length. That page may give you ideas even if your documentation covers a completely different subject.
Reply to this answer
Take a look at the Qt framework docs too. They're another useful comparison when you're deciding how to organize reference material for a framework rather than a single tool.
Reply to this answer
Older Linux documentation, including the Bash docs, is worth exploring as a different style of reference. It might not give you the layout you want, but it's useful to compare with more visual documentation.
Reply to this answer
Add your answer
Answers are reviewed before publication.
puzzle.PIECE+:
Worth looking at the individual page rather than assuming the whole documentation set follows the same pattern.