Engineering
Documentation
163 people are learning this skill right now!
Documentation is part of our Engineering Career Leveling Framework. Explore next steps in your career from this industry-standard model.
Curated Learning Resources
The Yelp Production Engineering Documentation Style GuideThe Yelp team shares their guide on making documentation discoverable, different types of documentation, and tips on writing documentation.
What nobody tells you about documentationDaniele discusses four types of software documentation: tutorials, how-to guides, technical reference and explanation.
Etsy’s experiment with immutable documentationPaul-Jean describes Etsy's approach towards maintaining up-to-date documentation: separating how-docs from why-docs, and optimizing for freshness rather than completeness with how-docs using a Slack tool.
The 4 Tenets of Good DocumentationJana explains how good code documentation should describe the code's purpose, function, form and usage.
Five ways to make your internal docs shineGreg offers some guidelines in writing documentation: 1. Ask your teammates what to document; 2. Make your docs timely, but not timeless; 3. Link to each doc from at least three places; 4. User test your docs; 5. Treat your docs as prepend-only.
Related Skills
