shinpr/codex-workflows · Archived

recipe-update-doc

Update existing design documents (Design Doc / PRD / ADR) with review and consistency verification.

First seen Jul 22, 2026

Installation

$ npx skills add shinpr/codex-workflows --skill recipe-update-doc

Stronger alternatives

This repository is archived — consider an actively maintained alternative.

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

Also in this package

Other skills from shinpr/codex-workflows · top by installs.

npx skills add shinpr/codex-workflows

Browse all from shinpr/codex-workflows

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 26
License LICENSE
Default branch main
Open issues 1
Status Archived

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 9,470 B
  • docs SUMMARY.md 124 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 1 installs

SKILL.md

Required Skills [LOAD BEFORE EXECUTION]

  1. [LOAD IF NOT ACTIVE] documentation-criteria — document creation rules and templates
  2. [LOAD IF NOT ACTIVE] subagents-orchestration-guide — agent coordination and workflow flows
  3. [LOAD IF NOT ACTIVE] llm-friendly-context — document update and review handoffs

Spawn rule: every spawnagent call uses forkturns="none" so the subagent receives only the task message and explicitly provided context.

Context: Dedicated to updating existing design documents.

Orchestrator Definition

Core Identity: Coordinate document updates, perform lightweight routing and status changes directly, and invoke document specialists for semantic authoring and review.

Execution Plan: Reuse the active execution plan. When the workflow has multiple dependent actions and no plan exists, create one that tracks them through final verification.

Execution Protocol:

  1. Invoke the named author and reviewer for document judgment; perform artifact selection, routing, explicit-answer application, and status updates directly
  2. Execute update flow:

- Identify target -> Clarify changes -> Update document -> Review -> Consistency check - Ask for missing change intent only when it cannot be recovered from the request and target document; obtain one document approval after review and applicable consistency verification

  1. Scope: Complete when updated document receives approval

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.

Workflow Overview

Target document -> Clarify changes -> update agent
                                      |
                    [Design Doc: code-verifier -> Review Resolution]
                                      |
                              document-reviewer
                                      |
                         [Design Doc: design-sync]
                                      |
                        [Stop: Document approval]

Scope Boundaries

Included in this skill:

  • Existing document identification and selection
  • Change content clarification with user
  • Document update with appropriate agent (update mode)
  • Document review with document-reviewer
  • Consistency verification with design-sync (Design Doc only)

Out of scope (redirect to appropriate skills):

  • New document design -> $recipe-design
  • Work planning or implementation -> $recipe-plan or $recipe-task

Responsibility Boundary: This skill completes with updated document approval.

Target document: $ARGUMENTS

Execution Flow

Step 1: Target Document Identification

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)

Step 2: Document Type and Layer Determination

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:

  • Frontend (-> technical-designer-frontend): Document title/scope mentions React, components, UI, frontend; or file contains component hierarchy, state management, UI interactions
  • Backend (-> technical-designer): All other cases (API, data layer, business logic, infrastructure)

ADR Update Guidance:

  • Minor changes (clarification, typo fix, small scope adjustment): Update the existing ADR file
  • Major changes (decision reversal, significant scope change): Create a new ADR that supersedes the original

Step 3: Change Content Clarification

Derive the sections, reason, and expected outcome from the user request and target document. Ask only for a missing item whose plausible interpretations would materially change the updated document.

For PRD or Design Doc updates, apply the confirmed changes to the target document's current outcome, requirements, and exclusions to form confirmedrequirementcontext; preserve fields the request does not change. Incorporate later user corrections or additions into the same context before the next update or review action. For ADR updates, use confirmedrequirementcontext: N/A — ADR update and carry the accepted decision plus the requested changes as governing context.

Step 4: Document Update

For PRD or Design Doc, spawn [Update Agent from Step 2]: "Operation Mode: update. Existing Document: [path from Step 1]. Changes Required: [Changes clarified in Step 3]. confirmedrequirementcontext: [Step 3 current context]. Update the document to reflect the specified changes. Add change history entry."

For a minor ADR change, spawn the update agent with Operation Mode: update, the existing path, confirmed changes, and confirmedrequirementcontext: N/A — ADR update. For a major ADR change, leave this update path and use the normal ADR creation and approval flow to create the superseding ADR.

Step 5: Document Review

For Design Doc updates, first verify the updated document against code:

Spawn code-verifier agent: "Verify the updated Design Doc against current code. doctype: design-doc. documentpath: [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."

Apply Review Resolution to every discrepancy. Pass the apply discrepancies to the update agent, rerun code-verifier, and store the resolved summary, declines with reasons, and material limitations as $VERIFICATION_RESOLUTION after the apply set becomes empty.

For Design Doc updates: Spawn document-reviewer agent: "Review the following updated document. doctype: DesignDoc. reviewcontext: update. target: [path from Step 1]. confirmedrequirementcontext: [Step 3 current context]. verificationresolution: $VERIFICATIONRESOLUTION. Focus on consistency of the updated sections, governing requirements, and change history."

For PRD updates, spawn document-reviewer with the target and confirmedrequirementcontext from Step 3. For minor ADR updates, use doctype: ADRBatch, targets: [updated ADR path], and reviewcontext: update; review the requested changes and their dependent consistency while carrying the accepted, unchanged decision content as governing context.

Store output as: $STEP5OUTPUT

On review result:

  • approved -> proceed to Step 6
  • needs_revision -> Apply Review Resolution with the update agent, then review the updated document
  • rejected -> Apply Orchestrator Escalation Resolution. Continue after self-resolution; ask the user only when that procedure reaches a user-decision condition

Step 6: Consistency Verification and Approval

For PRD or ADR, skip design-sync and present the reviewed document for user approval.

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:

  • No conflicts -> Present the reviewed and consistency-checked document for user approval
  • Conflicts detected -> Apply Orchestrator Escalation Resolution using both governing documents. Return to the responsible author when one document can be corrected without changing an approved decision; ask the user only when a governing decision must change

Error Handling

Error Action
Target document not found Report and end (suggest $recipe-design instead)
Sub-agent update fails or returns an unusable result Apply Orchestrator Escalation Resolution
Review Resolution requires a user-owned decision Apply Orchestrator Escalation Resolution
design-sync detects conflicts Apply Orchestrator Escalation Resolution against the governing sources

Completion Criteria

  • Identified target document
  • Resolved change content from the request and target document, asking only when material intent was missing
  • Built the current confirmedrequirementcontext from the target document and confirmed changes
  • Updated document via appropriate agent (update mode)
  • Applied Review Resolution to code-verifier discrepancies before document-reviewer for Design Doc updates
  • Spawned document-reviewer and addressed feedback
  • Spawned design-sync for consistency verification (Design Doc only)
  • Obtained user approval for updated document

Output Example

Document update completed.

  • Updated document: docs/design/[document-name].md
  • Approval status: User approved