recipe-update-doc

Update and verify design documents across Design Doc, PRD, and ADR workflows.

29|4|Updated Mar 17, 2026
One-click install
npx skills add https://github.com/shinpr/codex-workflows --skill recipe-update-doc-shinpr
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: recipe-update-doc
Source: https://github.com/shinpr/codex-workflows/tree/main/.agents/skills/recipe-update-doc
Command: npx skills add https://github.com/shinpr/codex-workflows --skill recipe-update-doc-shinpr

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill standardizes the process for updating existing design documents across Design Doc, PRD, and ADR, ensuring changes are clarified, implemented, reviewed, and aligned with other docs.

Core Features & Use Cases

  • Identify target documents in docs/design/, docs/prd/, or docs/adr/ and prepare updates.
  • Clarify changes with stakeholders, apply updates using the appropriate agent, and log a change history.
  • Validate updates through review and consistency checks before final approval.

Quick Start

Specify the target document path and required changes, then trigger the update-and-review flow.

Frequently Asked Questions about recipe-update-doc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I update a PRD or design doc while ensuring consistency across related documents?

To update a PRD or design doc while ensuring consistency, this Skill standardizes the process by enforcing change clarification, applying content updates, and checking alignment across Design Docs, PRDs, and ADRs. It logs change history to maintain cross-document consistency.

How do I enforce a review gate when modifying an ADR?

To enforce a review gate when modifying an ADR, the workflow integrates explicit user approvals and validation checks at each stopping point. It ensures design changes pass code-verification prechecks before the ADR update is finalized.

What is the best way to automate design document workflows with validation checks?

The best way to automate design document workflows with validation checks is to trigger the update-and-review flow, which automatically prepares updates, validates content through consistency checks, and enforces document-review steps before final approval.

Can I use this workflow to update documents stored in specific directories like docs/design or docs/adr?

Yes, you can use this workflow to update documents stored in specific directories, as it automatically identifies target documents located in docs/design/, docs/prd/, or docs/adr/ and prepares the appropriate updates based on the specified path.

Does updating a design doc require code verification before applying changes?

Yes, updating a design doc requires code verification, as the workflow enforces code-verification prechecks for design changes. This ensures that proposed updates are validated against the actual codebase before being applied to the document.