Review, edit & approve
Generated documentation is a strong first draft. dev-doc lets you correct any section in place and record that a person has reviewed it — and it protects that work when the project is analysed again.
Where you can edit and approve
- Every documentation section on the Overview tab — Summary, Architecture, Modules, API Surface, Tech Stack.
- Every diagram card on the Architecture tab.
- The inception and communication canvases on the Governance tab.
- Architecture decision records, which you write and update in the ADR editor.
Edit a section
- Click EditThe blue Edit button sits at the top-right of each section or card.
- Change the textSections are written in Markdown — headings with
#, lists with-, tables with|. Diagrams are edited as their diagram source. - SaveYour version replaces the generated one immediately and is marked as edited by you.
Approve a section
Click Approve when the content is correct. The section shows a green Approved badge, and the button becomes Unapprove in case you change your mind. Approval tells everyone reading the documentation that a person has checked this part.
Review top-down. Start with the Summary and the system-context diagram: if the big picture is right, the details usually are too. Approve as you go, so the remaining work stays visible.
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 the project has approved or edited sections, dev-doc first shows a list of them and asks which to keep. Kept sections are carried over unchanged; the rest are written fresh.
Not approved, not protected. Unapproved sections may be replaced by a complete re-analysis. Approve what you want to keep.