Skip to content

Commit fa5fc07

Browse files
committed
prompt: strengthen build from docs workflow
1 parent 274467e commit fa5fc07

1 file changed

Lines changed: 32 additions & 16 deletions

File tree

prompts/codex/build-from-docs.md

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,37 @@
1-
# Build From Docs Prompt
2-
3-
Use this prompt when the project docs are ready.
1+
# Build From Approved Documentation
42

53
```text
6-
Read the project documentation first.
4+
Read the repository instructions and all approved project documents before editing code.
5+
6+
Source-of-truth order:
7+
1. Explicit user instruction for this task
8+
2. Approved change/decision records
9+
3. PRD and acceptance criteria
10+
4. TRD and security architecture
11+
5. Database and API specifications
12+
6. UX/UI, permission, QA, deployment, and implementation plans
13+
14+
Before implementation:
15+
- Summarize the requested outcome
16+
- Map it to requirement IDs and acceptance criteria
17+
- Inspect the existing repository and identify affected files
18+
- Report conflicts, missing requirements, unsafe assumptions, and unrelated existing changes
19+
- Produce a bounded build plan with verification steps
20+
21+
During implementation:
22+
- Work in dependency order and preserve existing user changes
23+
- Enforce permissions, validation, and data rules server-side
24+
- Handle loading, empty, error, permission, conflict, and recovery states
25+
- Keep migrations and API changes backward compatible where required
26+
- Add or update tests with the feature
27+
- Do not add undocumented features or make external/destructive changes without authorization
28+
- Update documentation when an approved implementation decision changes it
729
8-
Use these files as the source of truth:
9-
- Project Brief
10-
- PRD
11-
- TRD
12-
- Database Schema
13-
- API Documentation
14-
- QA Test Plan
15-
- Implementation Plan
30+
Before completion:
31+
- Run relevant lint, tests, build, migration, and targeted QA checks
32+
- Compare the implementation with acceptance criteria
33+
- Report changed files, verification evidence, remaining risks, and follow-up work
34+
- Never claim a requirement is complete without code or test evidence
1635
17-
Work phase by phase.
18-
Keep the implementation aligned with the documented scope.
19-
Update the README when needed.
20-
Report missing requirements before making major assumptions.
36+
If a material product or architecture decision is missing, stop at the decision boundary and ask a focused question.
2137
```

0 commit comments

Comments
 (0)