Using Dev-Doc

Review, edit & approve

Generated documentation is a strong first draft. You can correct any section in place and record that a person has reviewed it — and Dev-Doc protects that work when the project is analysed again.

What can be edited

• Every section on the Overview tab — Summary, Architecture, Modules, API Surface, Tech Stack.
• Every diagram on the Architecture tab (as diagram source).
• The inception and communication canvases on the Governance tab.
• Architecture decision records, in the ADR editor.

Edit and approve

1. Click Edit at the top-right of a section. Sections are Markdown; diagrams are edited as their source.
2. Save — your version replaces the generated one and is marked as edited.
3. Click Approve when the content is correct. The section shows a green Approved badge.

Review top-down. Start with the Summary and the system-context diagram: if the big picture is right, the details usually are too.

What happens on a re-run

• An incremental re-analysis fills gaps and leaves finished sections alone.
• A complete re-analysis regenerates the documentation. If there are approved or edited sections, Dev-Doc first lists them and asks which to keep.

Unapproved sections may be replaced by a complete re-analysis — approve what you want to keep.