requirement-doc-store

Stores requirement documents into typed subdirectories using the req CLI.

2|Updated Jun 8, 2026
One-click install
npx skills add https://github.com/HACK-WU/skills --skill requirement-doc-store-hack-wu
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: requirement-doc-store
Source: https://github.com/HACK-WU/skills/tree/main/skills/requirement-doc-store
Command: npx skills add https://github.com/HACK-WU/skills --skill requirement-doc-store-hack-wu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? When multiple skills generate requirement-related documents (design docs, data flow diagrams, review reports, verification reports), they often end up scattered in inconsistent locations. This Skill enforces a unified storage convention so every document lands in the correct subdirectory of the requirement management system and stays traceable via meta.json. ## Core Features & Use Cases - Type-based path routing: Automatically maps document types (requirement, design, data_flow, review, demo, test, report) to their canonical storage paths under the requirement directory. - Lifecycle management via req CLI: Creates, updates, and deletes requirement entries with req create, req update, and req delete, managing status, tags, dependencies, commits, and document associations without manual meta.json edits. - Mandatory persistence verification: After every create or update, runs req list --id to confirm the entry exists and fields match, with retry-on-failure rules. - Use Case: After a design skill produces DESIGN.md, invoke this Skill to register it under design/DESIGN.md, update the requirement status to 设计中, and verify the association was recorded. ## Quick Start Store the generated design document for the user authentication requirement into the requirement management system and verify it was registered.

Frequently Asked Questions about requirement-doc-store

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

FAQPage Schema
How do I store a design document in the requirement management system?

Write the document to the design/ subdirectory of the requirement folder, then run req update with --docs add design/DESIGN.md,design to register the association. Finally verify with req list --id to confirm the docs field contains the new entry.

How do I create a new requirement entry with the req CLI?

Run req init first to generate .requirements/config, then use req create with --feature and --tags. The command auto-generates the ID, directory name, and meta.json entry, which you must verify afterward using req list --id.

Why does req create fail with a tag validation error?

Tags must come from the requirement_tags list in .requirements/config, and every requirement must include exactly one feature category tag from feature_categories. Check the config file and retry with allowed tag values.

Can I edit meta.json directly instead of using req commands?

No. The skill explicitly forbids manual meta.json edits. All metadata changes including status, tags, dependencies, commits, and document associations must go through req create, req update, or req delete to keep the store consistent.

How do I safely delete a requirement and its documents?

Preview the impact with req delete --dry-run to see reverse dependencies, then run req delete interactively or with --force for automation. The command cleans reverse dependency references, removes the meta.json entry, and deletes the requirement directory.