What you’ll learn
- How to define your audience clearly enough to use as context for AI writing tools
- How to categorize content by type, and why mixing types makes docs more difficult to navigate
- How to structure individual pages for scanning and successful task completion
- How to design navigation that reflects what users are trying to accomplish
- How to use behavior and feedback to find structural problems
- How to keep documentation accurate at scale, with automation handling the mechanical work
Who this is for
Developers, technical writers, and product teams who own documentation at a company using Mintlify. You don’t need a writing background. You just need to care about creating documentation that works for your users.Lessons in this course
- Understand your readers first—Why audience clarity is the foundation of every structural decision, and how to use it as context for AI writing tools.
- Choose the right content type—Different types of documentation and why mixing them makes it harder to navigate.
- Structure individual pages for scanning—How to organize prerequisites, headings, examples, troubleshooting, and verification.
- Design navigation for your users (not your product)—How to organize content around what users are trying to accomplish, and when to use groups, tabs, dropdowns, products, and anchors.
- Measure and improve findability—How to use search, analytics, support questions, and task testing to find structural problems.
- Keep docs accurate as your product grows—Ownership, agent-drafted updates, and automated checks that keep docs from going stale.