How It Works
From source code to living documentation in four steps.
The Lifecycle
Bootstrap
Bootstrap
Scan your codebase and discover features
The scanner reads your project structure, finds modules, classes, and functions, then proposes features with source-glob patterns and tags. Everything lands in .help/features.yaml as the single source of truth.
Generate
Generate
AI creates templates from your source code
For each feature, three Jinja-based templates are generated from actual source code: concept (what is it?), task (how to use it), and reference (full API detail). Each template includes a source hash in its frontmatter for staleness tracking.
Serve
Serve
Progressive help via attune-help or /coach
Ask about a topic and get the concept overview first. Ask again and you auto-advance to the task walkthrough. A third ask delivers the full reference. New topics always reset to concept depth.
Maintain
Maintain
Detect drift and regenerate stale templates
Source hashes in each template's frontmatter are compared against the current codebase. Only stale templates are regenerated. Hand-written templates marked status: manual are always preserved.
Progressive Depth
Each topic has three layers. Ask once for the overview, again for the walkthrough, a third time for the full reference.
What is it? When to use it?
A high-level overview that orients you. Explains purpose, context, and when to reach for this feature.
Step-by-step: how to do it
A practical walkthrough with commands, code snippets, and expected output. Gets you from zero to working.
Full detail, edge cases, API
Complete API surface, configuration options, edge cases, and caveats. The exhaustive resource.
Repeat calls auto-advance. New topic resets to concept.
AI Writes the First Draft. You Make It Yours.
Templates are generated from your source code, but you always have the final say.
Generated Templates
- •Created automatically from source code using Jinja templates
- •Frontmatter tracks source hash, status, and generation timestamp
- •Regenerated when source code changes and the hash drifts
Hand-Written Content
- •Edit any generated template or create new ones from scratch
- •Mark with
status: manualto protect from regeneration - •The maintenance pass always preserves hand-written templates
Ready to bootstrap your help system?
One command scans your codebase and generates living documentation.