بنقرة واحدة
recipe-update-doc
Update existing design documents (Design Doc / PRD / ADR) with review and consistency verification.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
القائمة
Update existing design documents (Design Doc / PRD / ADR) with review and consistency verification.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Anti-pattern detection, root-cause discipline, quality check workflow, and implementation completeness assurance. Use when: fixing bugs, reviewing code quality, refactoring, making technical decisions, or performing quality assurance.
Language-agnostic coding standards for maintainability, readability, and quality. Use when: implementing features, refactoring code, reviewing code quality, or writing functions.
Documentation creation criteria for PRD, ADR, Design Doc, UI Spec, and Work Plan with templates. Use when: creating or reviewing technical documents, determining which documents are required, or following document templates.
Implementation strategy selection framework with meta-cognitive approach. Use when: planning implementation strategy, selecting between vertical/horizontal slicing, or defining verification criteria for tasks.
Integration and E2E test design principles, value-based selection, test skeleton specification, and review criteria. Use when: designing integration tests, E2E tests, generating test skeletons, or reviewing test quality.
Guides subagent coordination through implementation workflows. Use when: orchestrating multiple agents, managing workflow phases, determining autonomous execution mode, or coordinating recipe execution.
| name | recipe-update-doc |
| description | Update existing design documents (Design Doc / PRD / ADR) with review and consistency verification. |
documentation-criteria — document creation rules and templatessubagents-orchestration-guide — agent coordination and workflow flowsllm-friendly-context — clear prompts, handoffs, and generated artifactsSpawn rule: every spawn_agent call uses fork_turns="none" so the subagent receives only the task message and explicitly provided context.
Context: Dedicated to updating existing design documents.
Core Identity: "I am not a worker. I am an orchestrator." (see subagents-orchestration-guide skill)
First Action: Register Steps 1-6 before any execution.
Execution Protocol:
[Stop: ...] marker -> Present status to user for confirmation. CANNOT proceed until user explicitly confirms.CRITICAL: MUST execute document-reviewer and all stopping points -- each serves as a quality gate for document accuracy. ENFORCEMENT: Skipping document-reviewer risks propagating inconsistencies to downstream workflows.
Target document -> [Stop: Confirm changes]
|
technical-designer / technical-designer-frontend / prd-creator (update mode)
| (Design Doc only)
code-verifier -> document-reviewer -> [Stop: Review approval]
| (Design Doc only)
design-sync -> [Stop: Final approval]
Included in this skill:
Out of scope (redirect to appropriate skills):
Responsibility Boundary: This skill completes with updated document approval.
Target document: $ARGUMENTS
Check for existing documents in docs/design/, docs/prd/, docs/adr/.
Decision flow:
| Situation | Action |
|---|---|
| $ARGUMENTS specifies a path | Use specified document |
| $ARGUMENTS describes a topic | Search documents matching the topic |
| Multiple candidates found | Present options to user |
| No documents found | Report and end (suggest $recipe-design instead) |
Determine type from document path, then determine the layer to select the correct update agent:
| Path Pattern | Type | Update Agent | Notes |
|---|---|---|---|
docs/design/*.md | Design Doc | technical-designer or technical-designer-frontend | See layer detection below |
docs/prd/*.md | PRD | prd-creator | - |
docs/adr/*.md | ADR | technical-designer or technical-designer-frontend | See layer detection below |
Layer detection (for Design Doc and ADR): Read the document and determine its layer from content signals:
ADR Update Guidance:
[STOP — BLOCKING] Present change summary to user for confirmation. CANNOT proceed until user explicitly confirms.
Ask the user to clarify what changes are needed:
Confirm understanding of changes with user before proceeding.
Spawn [Update Agent from Step 2] agent: "Operation Mode: update. Existing Document: [path from Step 1]. Changes Required: [Changes clarified in Step 3]. Update the document to reflect the specified changes. Add change history entry."
For Design Doc updates, first verify the updated document against code:
Spawn code-verifier agent: "Verify the updated Design Doc against current code. doc_type: design-doc. document_path: [path from Step 1]. verbose: false. Focus especially on literal identifier referential integrity for concrete paths, endpoints, type names, config keys, and other exact identifiers changed in this update."
Store output as: $CODE_VERIFICATION_OUTPUT
For Design Doc updates: Spawn document-reviewer agent: "Review the following updated document. doc_type: DesignDoc. target: [path from Step 1]. mode: composite. code_verification: $CODE_VERIFICATION_OUTPUT. Focus on: Consistency of updated sections with rest of document, no contradictions introduced by changes, completeness of change history."
For PRD or ADR updates: Spawn document-reviewer agent: "Review the following updated document. doc_type: [PRD or ADR]. target: [path from Step 1]. mode: composite. Focus on: Consistency of updated sections with rest of document, no contradictions introduced by changes, completeness of change history."
Store output as: $STEP_5_OUTPUT
[STOP — BLOCKING] Present review results to user for approval. CANNOT proceed until user explicitly confirms.
On review result:
Present review result to user for approval.
[STOP — BLOCKING] Present consistency verification results to user for final approval. CANNOT proceed until user explicitly confirms.
Skip condition: Document type is PRD or ADR -> Proceed to completion.
For Design Doc, spawn design-sync agent: "Verify consistency of the updated Design Doc with other design documents. Updated document: [path from Step 1]"
On consistency result:
| Error | Action |
|---|---|
| Target document not found | Report and end (suggest $recipe-design instead) |
| Sub-agent update fails | Log failure, present error to user, retry once |
| Review rejects after 2 revisions | Stop loop, flag for human intervention |
| design-sync detects conflicts | Present to user for resolution decision |
Document update completed.