Start Your Project
Products/Docs AI/Docs AI documentation formats

Docs AI documentation formats

Choose the documentation your project needs

A project README, an API reference and inline code comments solve different communication problems. Docs AI offers distinct documentation choices so developers can focus on the output useful for their current task.

Back to Docs AI

01

README

A README introduces a project to its readers. It can explain the purpose of the code, its main components and the information a developer needs to understand the project.

02

API reference

An API reference focuses on callable interfaces: functions, parameters, return values and usage details. It helps developers understand how to interact with a piece of code.

03

Inline comments

Inline comments place explanations close to the relevant code. They can help readers follow intent, understand non-obvious logic and navigate implementation details.

04

Full documentation

The Full Docs option is intended for broader documentation, bringing together project-level explanation, API details and inline documentation in one workflow.

Continue exploring

See what Docs AI can help you do.

Visit the product overview for its audience, key focus areas and next steps.

Explore Docs AI