Help us learn about your current experience with the documentation. Take the survey.

Output requirements

  • Write the complete documentation.
  • Read and follow the documentation principles file before writing documentation. The principles file is at the repository root: open the .ai directory and read principles/distilled/documentation.md.

Common mistakes to avoid in AI-generated documentation

  • Repetition: Do not restate information already covered earlier in the same page or in a linked topic.
  • Vague or unverifiable claims: Do not describe how a feature works unless you can ground it in the codebase or existing documentation.
  • Incorrect scope: Do not create a new page for a concept or procedure when a suitable page already exists.
  • Style guide adherence: Follow the terms, grammar, and formatting in the style guide.