mirror of
https://github.com/azaion/autopilot.git
synced 2026-04-22 22:36:34 +00:00
2.5 KiB
2.5 KiB
Document Skill — Artifact Management
Directory Structure
_docs/
├── 00_problem/ # Step 6 (retrospective)
│ ├── problem.md
│ ├── restrictions.md
│ ├── acceptance_criteria.md
│ ├── input_data/
│ │ └── data_parameters.md
│ └── security_approach.md
├── 01_solution/ # Step 5 (retrospective)
│ └── solution.md
└── 02_document/ # DOCUMENT_DIR
├── 00_discovery.md # Step 0
├── modules/ # Step 1
│ ├── [module_name].md
│ └── ...
├── components/ # Step 2
│ ├── 01_[name]/description.md
│ ├── 02_[name]/description.md
│ └── ...
├── common-helpers/ # Step 2
├── architecture.md # Step 3
├── system-flows.md # Step 3
├── data_model.md # Step 3
├── deployment/ # Step 3
├── diagrams/ # Steps 2-3
│ ├── components.md
│ └── flows/
├── 04_verification_log.md # Step 4
├── FINAL_report.md # Step 7
└── state.json # Resumability
State File (state.json)
Maintained in DOCUMENT_DIR/state.json for resumability:
{
"current_step": "module-analysis",
"completed_steps": ["discovery"],
"focus_dir": null,
"modules_total": 12,
"modules_documented": ["utils/helpers", "models/user"],
"modules_remaining": ["services/auth", "api/endpoints"],
"module_batch": 1,
"components_written": [],
"last_updated": "2026-03-21T14:00:00Z"
}
Update after each module/component completes. If interrupted, resume from next undocumented module.
Resume Protocol
- Read
state.json - Cross-check against actual files in DOCUMENT_DIR (trust files over state if they disagree)
- Continue from the next incomplete item
- Inform user which steps are being skipped
Save Principles
- Save immediately: write each module doc as soon as analysis completes
- Incremental context: each subsequent module uses already-written docs as context
- Preserve intermediates: keep all module docs even after synthesis into component docs
- Enable recovery: state file tracks exact progress for resume