Final Docs
# Final Doc Creation
You are Codex, acting as the repo documentation architect.
Goal:
Given that SPEC.md, ARCHITECTURE.md, and ROADMAP.md already exist and are solid, create the remaining supporting docs/folders that will materially improve build + ship quality over the long term. Keep the doc set lean, avoid “documentation for its own sake”.
Process:
1) Read SPEC.md, ARCHITECTURE.md, ROADMAP.md.
2) Scan the repo for existing docs (README, CONTRIBUTING, docs/, ADRs, API docs, runbooks, security/privacy notes).
3) Identify gaps that would cause pain in 2–8 weeks (onboarding, running locally, deploying, debugging, decisions, data, APIs, security).
4) Propose a minimal doc architecture and then create the files/folders.
What to create (only if relevant to this project, based on SPEC/ARCH):
Required (almost always):
- README.md (project purpose + local setup + common commands + how to run tests)
- docs/runbook.md (deploy, rollback, common failure modes, ops checks)
- docs/adr/ (decision records)
- docs/adr/0001-template.md
- docs/adr/0002-initial-architecture-decisions.md (only decisions we already made)
Nice-to-have if applicable:
- docs/api.md (or docs/api/...) for any API surface or internal contracts
- docs/data.md for schema/invariants/migrations/PII handling (if stateful data exists)
- SECURITY.md for security reporting and security posture notes (if public repo or handling sensitive data)
- CONTRIBUTING.md (if more than 1 dev now or soon)
- docs/testing.md (if test strategy is non-trivial)
- docs/observability.md (logging/metrics/tracing conventions) if production service
- docs/release.md (release steps, versioning, changelog rules) if you will ship often
Rules:
- Don’t invent commands or tools. If you can find real ones in package.json, Makefile, scripts/, CI configs, include them. Otherwise put placeholders like `<insert command>` and clearly mark them.
- Keep docs short and operational. Prefer checklists and “how to do X”.
- Avoid duplicates. If content belongs in README, don’t also put it in runbook.
- Create folders and files only when they have clear “update triggers”.
Output format:
A) Proposed docs tree (what you will add)
B) For each added file: purpose + update trigger (1 line each)
C) Create the files with initial content (markdown)
D) A short checklist of “fill in these placeholders next”
Now do it.when to use it
Community prompt sourced from the open-source GitHub repo kylehuirevvision/repo-rails (MIT). A "Final Docs" style prompt — adapt the placeholders and specifics to your task. Imported as-is and not independently retested here, so check the output before relying on it.
tags
roleplaycommunitygeneral
source
kylehuirevvision/repo-rails · MIT