3.4 KiB
name, description
| name | description |
|---|---|
| document-harness | Use when creating, running, or updating the staged Markdown document-writing Harness from docs/PRD.md through research notes, drafts, feedback gates, and final documents. |
Document Harness Skill
Use this skill to turn docs/PRD.md into researched, reviewable, and feedback-driven Markdown documents.
Operating Rules
- Read
GEMINI.md,docs/PRD.md,docs/ARCHITECTURE.md,docs/ADR.md, anddocs/UI_GUIDE.mdbefore planning document work. - Treat
docs/PRD.mdas the single source of requirements. - If PRD purpose, target reader, final deliverables, scope, or key questions are materially empty, stop and ask the user to complete PRD first.
- Use
docs/ResearchNote.mdas the evidence ledger before drafting externally factual content. - Store review drafts under
drafts/and final deliverables underfinal/. - Preserve
docs/DraftFeedback.mdanddocs/FinalFeedback.md; never delete user feedback. - Run
python scripts/validate_docs.pybefore reporting completion.
Staged Workflow
1. PRD Intake
Read docs/PRD.md and identify:
- document purpose
- target readers
- final deliverables
- required outline
- important keywords
- key questions
- scope boundaries
- tone and style constraints
- research requirements
2. Rule Synthesis
Update only the relevant project-specific guidance in GEMINI.md.
Include:
- document purpose and target readers
- final deliverables
- tone and style rules
- citation and verification standards
- draft and final feedback process
Keep the generic Gemini CLI configuration and repository workflow concise.
3. Research Note
Research PRD keywords and key questions. Prefer official, academic, government, institutional, or other primary sources.
Write docs/ResearchNote.md with:
- search date
- search terms
- source URLs
- source quality notes
- core findings
- conflicting claims
- unresolved questions
- intended document usage
Use doc-researcher or evidence-checker subagents when the user or current phase explicitly asks for subagent work.
4. Draft Documents
Create all PRD deliverables under drafts/.
Drafts must:
- answer the PRD key questions
- stay inside PRD scope
- use the requested tone
- link factual claims to
docs/ResearchNote.md - mark weak or missing evidence
After drafting, request user review in docs/DraftFeedback.md.
5. Draft Feedback Gate
If docs/DraftFeedback.md has no actionable user feedback or approval, mark the phase step as blocked with a clear blocked_reason.
If feedback exists, summarize it before revising.
6. Final Documents
Create final deliverables under final/. Do not overwrite drafts/.
Final documents must reflect:
- PRD requirements
- ResearchNote evidence
- DraftFeedback requests
- UI guide style rules
After finalizing, request user review or approval in docs/FinalFeedback.md.
7. Final Feedback Gate
If docs/FinalFeedback.md does not contain approval or actionable next feedback, mark the phase step as blocked.
If approval exists, mark the phase completed.
Phase Files
When creating a new phase, use references/phase-templates.md.
Each step must include:
- files to read
- exact task
- acceptance criteria
- validation procedure
- status update instructions
- concrete forbidden actions
Validation
Always run:
python scripts/validate_docs.py
For executor changes, also run:
python -m pytest scripts/test_execute.py