awesome-requirements-writer 0.1.0 → 0.2.0

package/README-zh.md

@@ -1,4 +1,5 @@
 # Awesome Requirements Writer
+v0.2.0
 
 作为一个具有十多年工作经验的汽车软件工程师和带领工程团队获得ASPICE认证的技术经理，我把多年来参与编写/评审技术产品需求的心得总结出来，写成了这个可复用的 AI agent skill，用于把工程笔记、客户输入、标准条款和测试期望转换为清晰、可测试的技术产品需求。
 
@@ -40,7 +41,7 @@
 ## 安装
 
 **方法一（推荐）：**
-直接告诉你的agent：安装awesome-requirements-writer。
+直接告诉你的agent：安装awesome-requirements-writer skill。
 
 **方法二：**
 
@@ -59,7 +60,7 @@ node --version
 ```
 
 
-确认node.js已安装后，运行：
+确认node.js已安装后，运行（若需 root 权限，应前缀sudo命令）：
 
 ```bash
 npx awesome-requirements-writer install
@@ -71,12 +72,19 @@ npx awesome-requirements-writer install
 npx awesome-requirements-writer install codex
 ```
 
-查看支持的目标：
+OpenClaw 和 Hermes 都可以读取 `SKILL.md` 风格的 skill 目录，因此复用同一份 canonical skill 包：
+
+```bash
+npx awesome-requirements-writer install openclaw
+npx awesome-requirements-writer install hermes
+```
+
+查看支持的CLI工具：
 
 ```bash
 npx awesome-requirements-writer list
 ```
-ß
+
 ## 使用
 
 显式调用 skill：
@@ -110,6 +118,7 @@ adapters/
 ```
 
 `SKILL.md` 是核心 agent 指令。`references/` 里的文件只在任务需要详细模板或汽车工程上下文时读取。
+OpenClaw 和 Hermes 复用 `SKILL.md` 包，不新增单独的 adapter wrapper。
 
 ## 平台适配
 
@@ -121,11 +130,13 @@ adapters/
 | Cursor | `adapters/cursor/.cursor/rules/` | `.cursor/rules/`，包含 `references/` |
 | Gemini CLI | `adapters/gemini/` | 合并到 `GEMINI.md`；把 references 复制到 `.gemini/awesome-requirements-writer/` |
 | OpenCode | `adapters/opencode/` | 将 `AGENTS.snippet.md` 合并到 `AGENTS.md`；把 references 复制到 `.opencode/awesome-requirements-writer/` |
+| OpenClaw | `adapters/codex/.agents/skills/awesome-requirements-writer/` | `~/.openclaw/skills/awesome-requirements-writer/` 或 workspace `skills/awesome-requirements-writer/` |
+| Hermes Agent | `adapters/codex/.agents/skills/awesome-requirements-writer/` | `~/.hermes/skills/awesome-requirements-writer/` |
 | CodeBuddy | `adapters/codebuddy/.codebuddy/rules/awesome-requirements-writer/` | `.codebuddy/rules/awesome-requirements-writer/`，包含 `RULE.mdc` 和 `references/` |
 | GitHub Copilot | `adapters/github-copilot/.github/` | `.github/`，包含 `copilot-instructions.md`、`instructions/` 和 `instructions/references/` |
 | Trae | `adapters/trae/.trae/` | Trae 项目规则路径，需确认当前版本使用 `.trae/project_rules.md` 还是 `.trae/rules/project_rules.md` |
 
-规则型 adapter 现在也包含 `references/`，但入口文件会明确要求 agent 不要默认加载全部 reference，只在任务需要时读取对应语言模板或汽车工程上下文。对于 `AGENTS.md` 或 `GEMINI.md` 这类固定入口文件，应把提供的 snippet 合并进用户已有文件，而不是覆盖。
+规则型 adapter 现在也包含 `references/`，但入口文件会明确要求 agent 不要默认加载全部 reference，只在任务需要时读取对应语言模板或汽车工程上下文。OpenClaw 和 Hermes 直接使用 canonical `SKILL.md` 包，不使用单独 wrapper 文件。这里的 OpenClaw/Hermes 支持表示支持本地 SKILL.md 兼容安装；在单独验证 ClawHub 或 Hermes registry 发布流程之前，不声明已经支持对应 registry 发布。对于 `AGENTS.md` 或 `GEMINI.md` 这类固定入口文件，应把提供的 snippet 合并进用户已有文件，而不是覆盖。
 
 CLI 安装器会自动用带标记的文本块完成合并。重复运行安装器会更新同一个标记块，不会反复追加重复内容。
 

package/README.md

@@ -1,8 +1,11 @@
 # Awesome Requirements Writer
+v0.2.0
 
-As an automotive software engineer with more than ten years of experience, and as a technical manager who has led engineering teams through ASPICE certification, I summarized what I have learned from years of writing and reviewing technical product requirements into this reusable AI agent skill. It helps turn engineering notes, customer inputs, standards, and test expectations into clear, testable technical product requirements.
+本skill支持中文技术需求文档编写，请浏览 简体中文(./README-zh.md) 内容。
 
-Some of the ideas behind this skill are discussed in an article I wrote: https://zhuanlan.zhihu.com/p/338598640
+As an automotive engineer and techinical manager with more than ten years of experience who has led engineering teams through ASPICE certification, I summarized what I have learned from years of writing and reviewing technical product requirements into this reusable AI agent skill. It helps turn engineering notes, customer inputs, standards, and test expectations into clear, testable technical product requirements.
+
+Some of the ideas behind this skill are discussed in an article I wrote (in Chinese) a couple years ago: https://zhuanlan.zhihu.com/p/338598640
 
 English | [简体中文](./README-zh.md)
 
@@ -67,6 +70,13 @@ This package also provides an optional installer CLI for target-specific adapter
 npx awesome-requirements-writer install codex
 ```
 
+OpenClaw and Hermes both consume `SKILL.md`-style skill folders, so they reuse the same canonical skill package:
+
+```bash
+npx awesome-requirements-writer install openclaw
+npx awesome-requirements-writer install hermes
+```
+
 List supported targets:
 
 ```bash
@@ -106,6 +116,7 @@ adapters/
 ```
 
 `SKILL.md` is the core agent instruction. The files in `references/` are loaded only when the task needs detailed templates or automotive engineering context.
+OpenClaw and Hermes reuse the `SKILL.md` package rather than adding a separate adapter wrapper.
 
 ## Adapters
 
@@ -117,11 +128,13 @@ adapters/
 | Cursor | `adapters/cursor/.cursor/rules/` | `.cursor/rules/`, including `references/` |
 | Gemini CLI | `adapters/gemini/` | Merge into `GEMINI.md`; copy references under `.gemini/awesome-requirements-writer/` |
 | OpenCode | `adapters/opencode/` | Merge `AGENTS.snippet.md` into `AGENTS.md`; copy references under `.opencode/awesome-requirements-writer/` |
+| OpenClaw | `adapters/codex/.agents/skills/awesome-requirements-writer/` | `~/.openclaw/skills/awesome-requirements-writer/` or workspace `skills/awesome-requirements-writer/` |
+| Hermes Agent | `adapters/codex/.agents/skills/awesome-requirements-writer/` | `~/.hermes/skills/awesome-requirements-writer/` |
 | CodeBuddy | `adapters/codebuddy/.codebuddy/rules/awesome-requirements-writer/` | `.codebuddy/rules/awesome-requirements-writer/`, including `RULE.mdc` and `references/` |
 | GitHub Copilot | `adapters/github-copilot/.github/` | `.github/`, including `copilot-instructions.md`, `instructions/`, and `instructions/references/` |
 | Trae | `adapters/trae/.trae/` | Trae project rules path, confirm whether your version uses `.trae/project_rules.md` or `.trae/rules/project_rules.md` |
 
-Rule-style adapters include bundled `references/`, but their entry files explicitly tell the agent not to load every reference by default. The agent should read only the matching language or automotive-context reference when the task needs it. For fixed entry filenames such as `AGENTS.md` or `GEMINI.md`, merge the provided snippet into the user's existing file instead of overwriting it.
+Rule-style adapters include bundled `references/`, but their entry files explicitly tell the agent not to load every reference by default. The agent should read only the matching language or automotive-context reference when the task needs it. OpenClaw and Hermes use the canonical `SKILL.md` package directly instead of a separate wrapper file. OpenClaw/Hermes support means local SKILL.md-compatible installation support; it does not claim ClawHub or Hermes registry publication until those registry flows are tested separately. For fixed entry filenames such as `AGENTS.md` or `GEMINI.md`, merge the provided snippet into the user's existing file instead of overwriting it.
 
 The CLI installer performs this merge automatically by using a marked block. Re-running the installer updates that block instead of appending duplicates.
 
@@ -142,4 +155,4 @@ Users can edit `SKILL.md` to adjust the core behavior, and can add company- or t
 
 ## License
 
-MIT
+MIT 

package/SKILL.md

@@ -29,13 +29,15 @@ A strong requirement is:
 1. Identify the item under requirement: product system, subsystem, feature, variant, and lifecycle phase.
 2. Extract stakeholder intent, system behavior, constraints, interfaces and validation expectations.
 3. Determine if the content is "information" or "requirement". Information is the content which is rationale, examples, diagrams, repeated else-defined requirements, and verification notes outside the normative requirement text.
-4. Classify requirements by type: functional (direct related to a specific feature or design), non-functional (performance, efficiency, expansion etc).
+4. Classify requirements by type: functional vs non-functional. 
 5. Draft atomic "shall" statements with a single subject, condition, behavior, measurable target, operating bounds, and verification path.
 6. Add metadata: type(information/requirement), ID , content body and acceptance criteria.
 7. List all functional requirements and related information in one chapter, while all non-functional requirements in another.
 8. In a new chapter make a table of all static variables and its value. If no value is given, type TBD.
 9. Audit the result for ambiguity, hidden design decisions, unverifiable claims, duplicate requirements, conflicting limits, missing fault behavior, and missing open questions.
 
+**Note:** Functional requirements are direct related to a specific feature or design, while non-functional requirements are related to general performance, system efficiency, software extensibility etc。 They are not direct related to feature level performance definition,more focusing on system level or product level. For example, "The fault flag shall be set within 100 ms after the fault occurs" is a functional requirement, while "The CPU load of the product shall be equal or less than 80%" is a non-functional requirement.
+
 ## Requirement Shape
 
 Use this format unless the user asks for another one:

package/bin/awesome-requirements-writer.js

@@ -19,6 +19,8 @@ const targets = [
   'gemini',
   'opencode',
   'opencli',
+  'openclaw',
+  'hermes',
   'codebuddy',
   'github-copilot',
   'copilot',
@@ -39,6 +41,8 @@ Targets:
   cursor             Install Cursor rules into the current project.
   gemini             Merge GEMINI.md instructions into the current project.
   opencode|opencli   Merge AGENTS.md instructions into the current project.
+  openclaw           Install as an OpenClaw SKILL.md package.
+  hermes             Install as a Hermes Agent SKILL.md package. Defaults to --global.
   codebuddy          Install CodeBuddy rules into the current project.
   github-copilot     Install GitHub Copilot repository instructions.
   trae               Install Trae project rules. Defaults to --variant rules.
@@ -58,6 +62,8 @@ Examples:
   npx awesome-requirements-writer install claude
   npx awesome-requirements-writer install cursor --cwd ./my-project
   npx awesome-requirements-writer install opencode --cwd ./my-project
+  npx awesome-requirements-writer install openclaw --cwd ./openclaw-workspace
+  npx awesome-requirements-writer install hermes
 `);
 }
 
@@ -265,6 +271,24 @@ function installOpenCode(options) {
   mergeMarkdownBlock(source('adapters', 'opencode', 'AGENTS.snippet.md'), projectPath(options, 'AGENTS.md'), options);
 }
 
+function installOpenClaw(options) {
+  const dest = options.project
+    ? projectPath(options, 'skills', skillName)
+    : homePath('.openclaw', 'skills', skillName);
+  copyDirSafe(source('adapters', 'codex', '.agents', 'skills', skillName), dest, options);
+}
+
+function installHermes(options) {
+  if (options.project) {
+    fail('hermes adapter is user-level only. Remove --project.');
+  }
+  copyDirSafe(
+    source('adapters', 'codex', '.agents', 'skills', skillName),
+    homePath('.hermes', 'skills', skillName),
+    options
+  );
+}
+
 function installTrae(options) {
   rejectGlobal('trae', options);
   if (!['rules', 'legacy'].includes(options.variant)) {
@@ -290,7 +314,7 @@ function install(target, options) {
   const normalized = normalizeTarget(target || 'agent');
   if (!normalized) fail(`Unknown target: ${target}. Run "npx awesome-requirements-writer list".`);
 
-  if (!options.global && !options.project && ['agent', 'codex', 'claude'].includes(normalized)) {
+  if (!options.global && !options.project && ['agent', 'codex', 'claude', 'openclaw', 'hermes'].includes(normalized)) {
     options.global = true;
   }
 
@@ -301,6 +325,8 @@ function install(target, options) {
     cursor: installCursor,
     gemini: installGemini,
     opencode: installOpenCode,
+    openclaw: installOpenClaw,
+    hermes: installHermes,
     codebuddy: installCodeBuddy,
     'github-copilot': installGitHubCopilot,
     trae: installTrae
@@ -325,6 +351,8 @@ function listTargets() {
   cursor
   gemini
   opencode (alias: opencli)
+  openclaw
+  hermes
   codebuddy
   github-copilot (alias: copilot)
   trae`);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "awesome-requirements-writer",
-  "version": "0.1.0",
-  "description": "Install an AI agent skill for writing clear, testable technical product requirements across Codex, Claude, Cursor, Gemini CLI, OpenCode, CodeBuddy, GitHub Copilot, and Trae.",
+  "version": "0.2.0",
+  "description": "Install an AI agent skill for writing clear, testable technical product requirements across Codex, Claude Code, Cursor, Gemini CLI, OpenCode, OpenClaw, Hermes Agent, CodeBuddy, GitHub Copilot, and Trae.",
   "license": "MIT",
   "homepage": "https://github.com/muchengracedriver/awesome-requirements-writer#readme",
   "repository": {
@@ -31,6 +31,9 @@
     "cursor",
     "gemini-cli",
     "opencode",
+    "openclaw",
+    "hermes",
+    "hermes-agent",
     "requirements",
     "technical-requirements"
   ],
@@ -38,7 +41,7 @@
     "node": ">=18"
   },
   "scripts": {
-    "test": "node bin/awesome-requirements-writer.js list && node bin/awesome-requirements-writer.js install --project --cwd /tmp/awr-install-test --dry-run && node bin/awesome-requirements-writer.js install codex --project --cwd /tmp/awr-install-test --dry-run",
+    "test": "node bin/awesome-requirements-writer.js list && node bin/awesome-requirements-writer.js install --project --cwd /tmp/awr-install-test --dry-run && node bin/awesome-requirements-writer.js install codex --project --cwd /tmp/awr-install-test --dry-run && node bin/awesome-requirements-writer.js install openclaw --project --cwd /tmp/awr-openclaw-test --dry-run && node bin/awesome-requirements-writer.js install hermes --dry-run",
     "pack:check": "npm --cache /tmp/awesome-requirements-writer-npm-cache pack --dry-run"
   }
 }