How it works

docu maister continuously drafts documentation from real code references. It’s designed for CI workflows: generate, review, merge, repeat.

1

Analyze the repository

Statically analyze the codebase to understand structure, modules, and boundaries — not just raw text.

2

Deduce architecture (high-level)

Infer how parts fit together (APIs, data flows, services) from actual code and dependencies.

3

Ground every claim in code

Generate documentation that cites real code references, so the output stays auditable and reviewable.

4

Generate static markdown

Produce plain markdown files you can publish anywhere (GitHub, internal portals, static sites).

5

Run in CI on every commit

Keep docs from drifting: the pipeline updates drafts automatically whenever the code changes.

6

Enrich with external context

Optionally pull additional inputs (ADRs, runbooks, tickets, conventions) via configuration.

next steps.

see a concrete output example, or compare plans.