Skip to main content
The guides in this section contain advice for creating documentation that helps your users succeed. Whether you’re starting from scratch or improving existing docs, these guides help you plan, write, and maintain your documentation. Above all else, consider your users’ needs and goals. Document what helps them use your product and get back to their tasks.

​
Topics

​
AI tools

Use AI-powered tools to accelerate your documentation workflow.
  • Automate documentation updates: Tutorial that teaches how to set up automated documentation updates using the agent.
  • Build an in-app assistant: Tutorial that teaches how to add an AI chat bot in a React app to help users find answers from your documentation.
  • Claude Code, Cursor, Windsurf: Guides for using AI coding assistants to maintain documentation.
  • GEO: Best practices for optimizing your documentation for AI search and answer engines.

​
API documentation

Create API documentation that lets users test and learn how to use your API, and is easy to maintain.
  • Migrate from MDX to OAS: Move your API documentation from individual MDX pages to autogenerated pages from an OpenAPI specifications.

​
Best practices

Make your documentation best in class.
  • Accessibility: Make your docs accessible to as many users as possible.
  • Content types: Choose the right format for tutorials, how-tos, references, and explanations.
  • Improve your docs: Use data and feedback to continuously improve your documentation.
  • Maintenance: Keep your documentation accurate and up-to-date.
  • Media: Add images, videos, and other media effectively while managing maintenance burden.
  • Organize navigation: Design information architecture that works for your users.
  • SEO: Optimize your docs for search engines.
  • Style and tone: Write with a consistent voice.
  • Understand your audience: Research and serve your users’ needs and goals.

​
Git workflows

Understand Git to get the most out of Mintlify and a docs-as-code approach to documentation.
  • Git concepts: Learn the fundamentals of Git for documentation.
  • Branches: Use branches to manage documentation changes.

​
Where to start

New to documentation?

Learn about content types to understand how to structure your docs.

Improving existing docs?

Learn how to use metrics and feedback to make your docs better.

Setting up AI features?

Automate documentation updates with the agent.

Working with a team?

Learn Git workflows for collaborative documentation.