Glossary & FAQ
Short definitions of the words you meet in dev-doc, followed by answers to frequent questions.
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. Started by an import or a re-analysis. |
| Incremental re-analysis | A run that keeps existing results and fills gaps. Faster and cheaper. |
| Complete re-analysis | A run that rebuilds everything from scratch and bills the whole project again. |
| Codebase analysis | Optional per-file explanations of the code. Chosen when importing or re-analysing. |
| Pricing model | The quality tier used for a project's runs (for example basic or premium). Higher tiers write richer documentation and cost more per run. |
| Credits | Your balance for paying for runs. Shown in the top bar. |
| Module | A self-contained part of the project — an application, library, service or test suite. |
| C4 model | A way of drawing software architecture at four zoom levels: context, containers, components, code. |
| ADR | Architecture Decision Record — a short document that records one important decision, its reasons and consequences. |
| Canvas | A one-page structured summary. dev-doc creates an inception canvas and a 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. |
| Demo project | A finished, read-only sample project that anyone can explore. |
| Share link | A public, read-only link to one of your projects' documentation. You can revoke it at any time. |
Frequently asked questions
Which languages and technologies are supported?
dev-doc reads a very wide range of programming languages — from current web and mobile stacks to established enterprise and legacy languages. Mixed-language repositories and monorepos are supported; each module is detected separately.
Do I have to include codebase analysis?
No. It is off by default. Without it you still get the overview, architecture diagrams and governance artefacts; only the per-file explanations (Codebase tab) are skipped. Include it when you want to understand individual files.
Can I stop a run?
Yes. While a project is running, click the stop control on its card in My Projects and confirm. Start it again later with re-analyse.
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. See Review, edit & approve.
Who can see my projects?
Only you — until you create a share link. A share link shows the documentation only, never your source code, and you can revoke it at any time.
Do credits expire?
No. Purchased credits stay on your balance until you use them.
How do I delete a project?
Click the bin icon on the project's card in My Projects and confirm. Deleting cannot be undone.
How do I report a problem or suggest something?
Click Feedback at the bottom-right of any page. You can rate the page, write a comment, and include a screenshot.