r2-req-module

Extract module-level requirements from project specifications into template-structured documents.

2|1|Updated Nov 20, 2025
One-click install
npx skills add https://github.com/silentbalanceyh/r2mo-lain --skill r2-req-module
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: r2-req-module
Source: https://github.com/silentbalanceyh/r2mo-lain/tree/main/skills/r2-req-module
Command: npx skills add https://github.com/silentbalanceyh/r2mo-lain --skill r2-req-module

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

本技能旨在从项目上下文中提取模块级需求,并生成严格遵循模板结构的规格文档。

Core Features & Use Cases

  • 自动提取模块级需求并生成符合模板的规格文档。
  • 输入来源包括 .r2mo/requirements/project.md(只读)、.r2mo/requirements/project-module.md(模板参考、只读)、.r2mo/api/metadata.yaml、.r2mo/api/operations/**/.md、.r2mo/api/components/schemas/.md、.r2mo/domain/*.proto(可选)以及 .r2mo/design/spec.md(可选)。
  • 输出将生成 src/pages/{module}/requirement.module.md(模块需求文档)与 src/pages/{module}/metadata.yaml(模块配置信息)。

Quick Start

使用 r2-req-module 技能从项目规范中提取模块需求。

Frequently Asked Questions about r2-req-module

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

FAQPage Schema
How do I extract module requirements from project specifications?

Extracting module requirements from project specifications involves reading .r2mo/requirements/project.md and API metadata to generate structured module-level requirement documents following a fixed template structure.

What inputs are needed to generate module-level requirement documents?

Generating module-level requirement documents requires inputs including .r2mo/requirements/project.md, project-module.md templates, .r2mo/api/metadata.yaml, operations markdown files, schema files, and optionally proto definitions and design specs.

How do I document module requirements from API metadata and proto files?

Documenting module requirements from API metadata and proto files involves parsing .r2mo/api/operations and .r2mo/domain/*.proto sources, then writing validated YAML headers and markdown content to src/pages/{module}/requirement.module.md.

Can I use .r2mo design specs as optional inputs for module requirement extraction?

Yes, you can use .r2mo/design/spec.md as an optional input for module requirement extraction alongside mandatory API operations and schema files to enrich the generated module specification documentation.

What is the best way to structure module requirement outputs from specification files?

The best way to structure module requirement outputs is to place requirement.module.md and metadata.yaml under src/pages/{module}/ directories, enforcing strict YAML header validation and fixed template adherence.

Why does module requirement extraction require strict YAML header validation?

Module requirement extraction requires strict YAML header validation to ensure generated specification documents conform to the fixed template structure, maintaining consistency across module configuration files and requirement markdown outputs.