Writing documentation is labor-intensive yet essential for managing shared codebases. Dosu helps lighten the load by generating and maintaining docs for you.

Approach#

Dosu synthesizes documentation using multiple inputs—including:

• Code
• Conversations
• Tickets
• Reviews

It analyzes all of these sources to automatically generate documentation, and keeps it in sync as your project evolves.

Usage#

This feature is currently in beta, but it’s available from the dashboard.

1. Click “Documentation” in the left navigation.
2. Click “+ New”.
3. Fill out your details and select data sources.
4. Click Generate.
5. The result appears as a Draft.
6. If desired, click Publish on the draft to enable ongoing updates from Dosu.

Additional Context#

• Dosu is designed to minimize the friction of documentation, empowering engineers to document features or investigations 100× faster than writing from scratch.
• More recently, Dosu introduced One-Click Documentation via suggestions based on recent activity. It detects recent changes and offers to generate new docs with a single click.
• Dosu's philosophy is to let users build while it handles documentation (“you build, Dosu documents”).

Next Steps#

With Generate Docs enabled, you can quickly move from empty pages to structured, review-ready documentation.

• Use Drafts for early iterations.
• Click Publish once you’re happy, and Dosu will help keep it up to date.
• Pair this with Maintain Docs to ensure your documentation remains up-to-date.

Documentation shouldn’t slow you down. Dosu integrates it into your everyday workflow.