The Brief
Replace this with the actual context. What was being documented? Who were the readers? What did the old docs look like?
Example: An open-source CLI tool had docs scattered across a README and a GitHub wiki. Contributors were confused, new users dropped off during setup, and there was no search. It needed a real documentation site.
What I Built
Describe the structure and features of the documentation site.
- Versioned content structure
- Full-text search
- Code blocks with syntax highlighting and copy button
- Navigation that scales across a large content tree
- Mobile-friendly reading experience
Content Architecture
Good documentation is as much about structure as it is about writing. Walk through how you organised the content — guides vs. reference vs. tutorials, versioning strategy, URL structure.
Results
Time-to-first-success for new users, contribution rate, search traffic, or maintainer feedback. Replace with your real outcome.