Create, expand, and validate a “docs-as-code” documentation set for any software project (not domain-specific). Use when asked to scaffold a full project documentation structure (docs/, specs/, epics/, prototypes/), write core documents (charter, roadmap, architecture, module/service specs, runbooks, optional compliance/traceability), add delivery planning (sprints, UX/design backlog), and create AI-agent implementation guidance (implementation plan + AGENT.md).
python3 <SKILL_DIR>/scripts/scaffold_project_docs.py --root . --project-name "My Project" --owner "Architecture + Product" --with-specs --with-epics --with-opspython3 <SKILL_DIR>/scripts/scaffold_project_docs.py --root . --project-name "My Project" --owner "Architecture + Product" --with-specs --with-epics --with-ops --with-compliancepython3 <SKILL_DIR>/scripts/check_md_links.py --root .Replace <SKILL_DIR> with the installed skill path (e.g., ~/.codex/skills/project-docs-generator).
Ask the user the minimum questions from:
references/questionnaire.mdDo not start writing “final” docs until you can answer at least:
If details are missing, keep explicit TODO markers and add an “Open questions” section with owners.
Use the default blueprint described in:
references/docs-blueprint.mdThen scaffold with scripts/scaffold_project_docs.py.
When writing docs that cite standards, use authoritative sources and record them explicitly.
Use:
references/research-sources.mdRules:
assets/templates/standard/docs/06-compliance/).Recommended sequence:
docs/DOCS_GOVERNANCE.md + docs/STYLE_GUIDE.md (sets the quality bar).docs/00-project-charter.md + docs/00-vision-roadmap.md (why/what/when).docs/02-architecture/* (system map, responsibilities, integrations, security, observability).docs/03-modules/* (module/service specs that link to contracts).specs/* (OpenAPI/AsyncAPI/file specs) and link them from the relevant module docs.docs/01-discovery/* (journeys, screen inventory, UI/UX stories, wireframe checklist, design backlog).epics/* (delivery backlog; stories with acceptance criteria + outputs).epics/sprints/* (sprint plan, per-sprint backlogs, refinement).docs/00-ai-agent-implementation-plan.md + AGENT.md (AI agent execution guidance).docs/07-operations/* (runbooks, DR, incident response).docs/06-compliance/* (requirements register, traceability, retention/legal hold).Use the “quality bar” checklist in:
references/quality-bar.mdpython3 <SKILL_DIR>/scripts/check_md_links.py --root .specs/QUALITY_GATES.md (or generate one via templates)assets/templates/standard/ (docs/ + specs/ + epics/ + prototypes/)references/questionnaire.md (what to ask)references/docs-blueprint.md (what to generate)references/research-sources.md (what to cite)references/quality-bar.md (definition of done)scripts/scaffold_project_docs.py (scaffold the docs set)scripts/check_md_links.py (validate repo-local Markdown links)