Getting Started
Glossary & FAQ
Glossary
| Term | Meaning |
|---|---|
| Project | One imported repository or zip file and all documentation produced for it. |
| Analysis / run | One pass that reads the code and (re)writes the documentation. |
| Incremental re-analysis | Keeps existing results and fills the gaps. Faster and cheaper. |
| Complete re-analysis | Rebuilds everything and bills the whole project again. |
| Codebase analysis | Optional per-file explanations of the code. |
| Pricing model | The quality tier used for a project’s runs. |
| Credits | Your balance for paying for runs. |
| Module | A self-contained part of the project — application, library, service or test suite. |
| C4 model | Software architecture drawn at four zoom levels: context, containers, components, code. |
| ADR | Architecture Decision Record — one important decision, its reasons and consequences. |
| Canvas | A one-page structured summary (inception and communication canvas). |
| Approve | Mark a section as reviewed by a person. Approved content is protected on re-runs. |
| Repository tracking | A link between a project and its repository, so documentation can be refreshed against new commits. |
| Share link | A public, read-only link to a project’s documentation. Revocable. |
FAQ
Do I have to include codebase analysis? No, it is off by default. Without it you still get Overview, Architecture and Governance.
Can I stop a run? Yes — click the stop control on the project card in My Projects. Work already finished is kept.
Will a re-run overwrite my edits? Not if you approved them. Before a complete re-analysis, Dev-Doc asks which edited or approved sections to keep.
Who can see my projects? Only you — until you create a share link or add the project to a workgroup. A share link never shows source code.
Do credits expire? No.
How do I report a problem? Click Feedback at the bottom-right of any page in the app.