Generating documentation from scratch

Amendary can write a new document for one of your connected repositories instead of only correcting existing pages. Any member of your workspace can start a generation job, as long as the workspace isn't suspended and the feature is turned on for your team.

Before you start, decide where the finished document should live: a Notion page or a location in the repository itself. You'll also need available generation credits, since a full run spends credits based on the size of the repository's history.

<aside> ✏ Every new workspace gets one free run of the product-updates changelog type. Every other document type, and every run after that first free one, uses paid credits.

</aside>

How generation credits work

Building the estimate and reviewing the outline is free. Credits are only held when you commit to running the full document. If your balance is too low, Amendary tells you exactly how many more credits you need before you can proceed.

Start a new generation job

  1. Open the documentation generation wizard and choose the repository you want documentation for.
  2. Choose a destination: a Notion page (pick the connection and parent page) or a location inside the repository.
  3. Choose the document type: prose, runbook, incident report, product-updates changelog, or architecture decision record (ADR).
  4. Choose the intended audience: technical documentation or customer-facing help content.
  5. Set the depth and tone for the writing, and add any guidance notes to steer the result.
  6. Optionally adjust the writing style skills applied to this run. If you don't change them, your workspace's default style skills apply.
  7. Select Create job.

Result: Amendary builds the repository context and calculates a credit estimate for a full-history run. Nothing is written yet and no credits are spent at this step.

<aside> ✏ If the document type doesn't fit its expected structure (runbook, incident, product update, and ADR all follow a fixed section template), the wizard checks this before it lets the run proceed.

</aside>

Review the quote and start the run

Before committing, check the job's quote screen. It shows: