Who this is for
Developers, technical writers, and product teams who maintain content. Some lessons focus on Mintlify, but the principles apply to any platform. You don’t need a background in AI or machine learning, just an interest in making your content work well for anyone (or anything) that reads it.Lessons in this course
- How agents read your content—How agents find and fetch your pages, and the technical problems that make them fail silently.
- Write content agents can use—Writing habits that make each page reliable context for agents.
- Help agents find and read your content—Configure
llms.txt, Markdown output, your MCP server, andskill.md. - Give agents your team’s conventions—Write instruction files for the AI tools that help your team write docs.
- Test whether agents can use your content—Build a repeatable question set and check your technical setup.
- Protect private and sensitive information—Separate discovery from access control and test what each audience can retrieve.
- Keep content agent-friendly over time—Use analytics and agent feedback to keep content accurate as your product changes.
Agent-friendly content checklist
Use this as a quick reference.Content
- Every page makes sense without reading adjacent pages
- Page titles are specific enough to match user questions (“Configure rate limits for API requests” instead of “Advanced configuration”)
- Every page has a description that names the task and topics it covers
- Headings make sense without surrounding context
- Each page covers one topic or task
- Terminology is consistent, with one name per concept
Examples and references
- Code examples are complete and runnable
- Placeholder values are clear and explain what to substitute
- Cross-references name what they link to. No “click here,” “the above,” or similar
Configuration
- The
descriptionindocs.jsonexplains what your product does - Deprecated, internal, and pre-release pages are marked
hidden: trueornoindex: true - Your MCP server is easy for users to connect, for example through the contextual menu
-
.mintlify/AGENTS.mddefines audience, terminology, and content type rules for Mintlify’s agent - Private content is protected by authentication, not just hidden
-
mint scorepasses the checks that matter for your site
Evaluation
- A saved set of user questions covers lookup, tasks, troubleshooting, ambiguity, and unsupported requests
- Expected facts and supporting sources are recorded for each question
- Each run records which agent was tested and how it accessed your content
- The question set runs after major content, terminology, configuration, or access changes
Ongoing maintenance
- Assistant analytics and agent feedback are reviewed regularly
- Content is updated alongside product changes
- Agent instruction files are updated when terminology changes