modify documents
This commit is contained in:
@@ -0,0 +1,45 @@
|
||||
---
|
||||
name: "document-review"
|
||||
description: "Use when reviewing Markdown document changes for PRD alignment, source traceability, feedback coverage, structure, and final delivery readiness."
|
||||
---
|
||||
|
||||
# Document Review Skill
|
||||
|
||||
Use this skill to review changed Markdown files in the Codex Markdown Document Harness.
|
||||
|
||||
## Read First
|
||||
|
||||
- `AGENTS.md`
|
||||
- `docs/PRD.md`
|
||||
- `docs/ResearchNote.md`
|
||||
- `docs/DraftFeedback.md`
|
||||
- `docs/FinalFeedback.md`
|
||||
- `docs/ARCHITECTURE.md`
|
||||
- `docs/ADR.md`
|
||||
- `docs/UI_GUIDE.md`
|
||||
|
||||
## Review Checklist
|
||||
|
||||
1. PRD alignment: purpose, target reader, deliverables, scope, and tone match `docs/PRD.md`.
|
||||
2. Source traceability: external facts, dates, statistics, claims, and quotations connect to `docs/ResearchNote.md`.
|
||||
3. Structure: heading hierarchy, section order, and file names match the intended deliverables.
|
||||
4. Feedback coverage: `docs/DraftFeedback.md` or `docs/FinalFeedback.md` requests are addressed.
|
||||
5. Draft/final separation: drafts live under `drafts/`; final deliverables live under `final/`.
|
||||
6. Style quality: avoid generic AI prose, unsupported superlatives, repetition, and vague claims.
|
||||
7. Validation: `python scripts/validate_docs.py` passes.
|
||||
|
||||
## Output Format
|
||||
|
||||
Lead with findings. Use this table when a full checklist result is useful:
|
||||
|
||||
| 항목 | 결과 | 비고 |
|
||||
|------|------|------|
|
||||
| PRD 정합성 | PASS/FAIL | {상세} |
|
||||
| 출처 추적 | PASS/FAIL | {상세} |
|
||||
| 문서 구조 | PASS/FAIL | {상세} |
|
||||
| 피드백 반영 | PASS/FAIL | {상세} |
|
||||
| 초안/최종본 분리 | PASS/FAIL | {상세} |
|
||||
| 문체 품질 | PASS/FAIL | {상세} |
|
||||
| 검증 가능성 | PASS/FAIL | {상세} |
|
||||
|
||||
If there are issues, include concrete file paths and suggested fixes.
|
||||
Reference in New Issue
Block a user