Docs Requirement Sync
Productivitydocs-requirement-syncDocs 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.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
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
- 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
- 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
-
After implementation, update the CR to
activeand setcommit_ref. -
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
- 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
- One implementation/commit must have one CR file.
- CR must include
req_id + commit_reffor traceability. - Requirement status cannot move to
doneunless there is at least oneactiveCR. CHANGELOG_PROJECT.mdis summary only. Detailed rollback/restore info lives in CR files.
References
docs/changes/records/TEMPLATE_CHANGE_RECORD.mddocs/changes/records/INDEX.mddocs/product/requirements/REQ-TEMPLATE.md