OpenParable
Skip to content
← Back to skills

Docs Requirement Sync

Productivity
docs-requirement-sync

Docs Requirement Sync is an Agent Skill for productivity published in the majiayu000/claude-skill-registry repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Drive implementation from requirement docs (REQ) and enforce compact change records (CR) for every implementation/commit. Use when developing a new requirement and keeping REQ, Backlog, Product, Roadmap, Changelog, and records in sync.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/majiayu000/claude-skill-registry/blob/HEAD/skills/documents/docs-requirement-sync-kongxiangning-termlink/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/docs-requirement-sync, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Docs Requirement Sync

Use this skill when implementing a requirement from docs/product/requirements/REQ-*.md.

Run commands from repository root: E:\coding\TermLink

Workflow

  1. Validate the REQ before coding:
powershell -ExecutionPolicy Bypass -File ./skills/docs-requirement-sync/scripts/validate-req.ps1 -ReqPath ./docs/product/requirements/REQ-YYYYMMDD-slug.md -Strict
  1. Create a draft change record (CR) before or during implementation:
powershell -ExecutionPolicy Bypass -File ./skills/docs-requirement-sync/scripts/new-change-record.ps1 -ReqId REQ-YYYYMMDD-slug -Slug short-topic
  1. After implementation, update the CR to active and set commit_ref.

  2. Validate CR format:

powershell -ExecutionPolicy Bypass -File ./skills/docs-requirement-sync/scripts/validate-change-record.ps1 -RecordPath ./docs/changes/records/CR-YYYYMMDD-HHMM-short-topic.md -Strict
  1. Check full doc sync before marking requirement done:
powershell -ExecutionPolicy Bypass -File ./skills/docs-requirement-sync/scripts/check-doc-sync.ps1 -ReqId REQ-YYYYMMDD-slug

Mandatory Rules

  1. One implementation/commit must have one CR file.
  2. CR must include req_id + commit_ref for traceability.
  3. Requirement status cannot move to done unless there is at least one active CR.
  4. CHANGELOG_PROJECT.md is summary only. Detailed rollback/restore info lives in CR files.

References

  1. docs/changes/records/TEMPLATE_CHANGE_RECORD.md
  2. docs/changes/records/INDEX.md
  3. docs/product/requirements/REQ-TEMPLATE.md