new-command-docs

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

New Command Documentation Checklist

新命令文档检查清单

When a new ArcKit command is added, 11 files across the repository must be updated to reflect the new command. This skill provides the complete checklist and exact patterns for each update.

当新增ArcKit命令时，需要更新仓库中11个文件以体现该新命令。本技能提供了完整的检查清单以及每个更新项的具体格式规范。

Pre-flight Checks

前置检查

Before starting, verify these files exist for the new command:

Command file:
```
arckit-claude/commands/{name}.md
```
(required)

Template file:

.arckit/templates/{name}-template.md

AND

arckit-claude/templates/{name}-template.md

(required for document-generating commands, skip for utility commands like

customize

pages

trello

)

Guide file:
```
docs/guides/{name}.md
```
AND
```
arckit-claude/guides/{name}.md
```
(create if missing, see Guide Creation below)

If any required file is missing, create it before proceeding. Templates should be identical between

.arckit/templates/

and

arckit-claude/templates/

. Guides should be identical between

docs/guides/

and

arckit-claude/guides/

(except

migration.md

and

customize.md

which have path differences).

开始更新前，请确认新命令对应的以下文件已存在：

命令文件：
```
arckit-claude/commands/{name}.md
```
（必填）

模板文件：

.arckit/templates/{name}-template.md

和

arckit-claude/templates/{name}-template.md

（仅文档生成类命令必填，

customize

、

pages

、

trello

等工具类命令可跳过）

指南文件：
```
docs/guides/{name}.md
```
和
```
arckit-claude/guides/{name}.md
```
（若缺失请创建，详见下方指南创建部分）

若任何必填文件缺失，请先创建后再继续。

.arckit/templates/

和

arckit-claude/templates/

下的模板内容需完全一致。

docs/guides/

和

arckit-claude/guides/

下的指南内容也需完全一致（

migration.md

和

customize.md

因路径差异除外）。

Determine the New Count

确定新命令数量

Read the current count from

arckit-claude/.claude-plugin/plugin.json

(the

description

field contains the current count, e.g., "50 slash commands"). The new count is current + 1.

从

arckit-claude/.claude-plugin/plugin.json

文件中读取当前命令数量（

description

字段包含当前数量，例如："50 slash commands"）。新数量为当前数量加1。

Update Checklist

更新检查清单

Work through these 11 files in order. For exact grep patterns, insertion formats, and line-level detail, see references/file-locations.md.

按顺序完成以下11个文件的更新。如需精确的grep匹配规则、插入格式和行级细节，请查看references/file-locations.md。

1. README.md (root)

1. README.md（根目录）

Update 4 count locations and add a command table row:

Line ~35:
```
"all {N} commands, autonomous agents"
```
(Claude Code plugin section)
Line ~41:
```
"all {N} commands, templates, scripts"
```
(Gemini extension section)

Line ~742:

"All {N} ArcKit commands with maturity status"

(Command Reference intro)

Line ~995:
```
"the {N}x{N} command matrix"
```
(Reference packs section)
Command table: Add a row in the appropriate category section (Foundation, Strategic Context, Requirements & Data, Research & Strategy, Cloud Research, Data Source Discovery, Procurement, Design & Architecture, Implementation, Quality & Governance, UK Government, UK MOD, Documentation & Publishing). Insert alphabetically within the category.

Table row format:

markdown

| `/arckit.{name}` | Description of what the command does | [v1](link) [v2](link) | Status |

Status values:

Live

Beta

Experimental

更新4处数量位置并添加一行命令表格内容：

约第35行：
```
"all {N} commands, autonomous agents"
```
（Claude Code插件部分）
约第41行：
```
"all {N} commands, templates, scripts"
```
（Gemini扩展部分）

约第742行：

"All {N} ArcKit commands with maturity status"

（命令参考介绍部分）

约第995行：
```
"the {N}x{N} command matrix"
```
（参考包部分）
命令表格：在对应分类章节（Foundation、Strategic Context、Requirements & Data、Research & Strategy、Cloud Research、Data Source Discovery、Procurement、Design & Architecture、Implementation、Quality & Governance、UK Government、UK MOD、Documentation & Publishing）中添加一行，在分类内按字母顺序插入。

表格行格式：

markdown

| `/arckit.{name}` | 命令功能描述 | [v1](链接) [v2](链接) | 状态 |

状态可选值：

Live

、

Beta

、

Experimental

2. docs/index.html

Update 8 count locations and add an HTML command card. See references/html-patterns.md for the full HTML template.

Count locations (search for the old number):

```
<meta name="description">
```
tag (~line 6)
```
<meta property="og:description">
```
tag (~line 10)
Intro paragraph "{N} AI-assisted commands" (~line 459)
```
<h2>
```
heading "{N} ArcKit Commands" (~line 670)

<span id="visible-count">

and adjacent text (~line 729):

Showing <span id="visible-count">{N}</span> of {N} commands

(TWO numbers on this line)

Gemini CLI section "all {N} commands" (~line 1423)
Footer "All {N} commands documented" (~line 1558)

Important: The

visible-count

span and its adjacent count BOTH need updating. The JavaScript filter counter uses the span, while the static text shows the total.

更新8处数量位置并添加HTML命令卡片。完整HTML模板请查看references/html-patterns.md。

数量位置（搜索旧数字）：

```
<meta name="description">
```
标签（约第6行）
```
<meta property="og:description">
```
标签（约第10行）
介绍段落中的"{N} AI-assisted commands"（约第459行）
```
<h2>
```
标题"{N} ArcKit Commands"（约第670行）

<span id="visible-count">

及相邻文本（约第729行）：

Showing <span id="visible-count">{N}</span> of {N} commands

（该行有两个数字需要更新）

Gemini CLI部分的"all {N} commands"（约第1423行）
页脚的"All {N} commands documented"（约第1558行）

重要提示：

visible-count

span标签及其相邻的数字都需要更新。JavaScript过滤器计数器使用span标签中的值，而静态文本显示的是总数。

3. arckit-claude/.claude-plugin/plugin.json

Update the

description

field count:

json

"description": "The Enterprise Architecture Governance Harness - {N} slash commands across strategy, architecture, delivery, and assurance"

更新

description

字段中的数量：

json

"description": "The Enterprise Architecture Governance Harness - {N} slash commands across strategy, architecture, delivery, and assurance"

4. .claude-plugin/marketplace.json (root)

4. .claude-plugin/marketplace.json（根目录）

Update the

description

field count:

json

"description": "{N} slash commands across strategy, architecture, delivery, and assurance — including UK Government compliance"

更新

description

字段中的数量：

json

"description": "{N} slash commands across strategy, architecture, delivery, and assurance — including UK Government compliance"

5. arckit-claude/README.md

Check for any command count references and update. Look for patterns like "{N} commands" or "{N} slash commands".

检查所有命令数量相关引用并更新。查找类似"{N} commands"或"{N} slash commands"的格式。

6. docs/DEPENDENCY-MATRIX.md

This is the most complex update. See references/dependency-matrix-format.md for detailed format.

Steps:

Add column: Add
```
| {name}
```
to the header row (line 20) in alphabetical position among existing commands
Add cells: Add
```
|  |
```
(empty cell) to every existing row at the same column position
Fill dependencies: In each existing command's row, fill in M/R/O if the new command consumes that command's output
Add row: Add a new row for the command with its dependencies on other commands
Update tier groupings: Add the command to the appropriate tier section (Tier 0-12)
Update critical paths: Add to relevant workflow paths if applicable
Update version section: Bump "Commands Documented" count
Add changelog entry: Add a dated entry at the top of the Changelog section

Changelog entry format:

markdown

undefined

这是最复杂的更新项。详细格式请查看references/dependency-matrix-format.md。

步骤：

添加列：在表头行（第20行）中按字母顺序插入
```
| {name}
```
添加单元格：在每一行的对应列位置添加
```
|  |
```
（空单元格）
填充依赖关系：在现有命令的每一行中，若新命令依赖该命令的输出，则填入M/R/O
添加行：为新命令添加一行，填写其对其他命令的依赖关系
更新层级分组：将新命令添加至对应层级章节（Tier 0-12）
更新关键路径：若适用，将其添加至相关工作流路径中
更新版本章节：增加"Commands Documented"的数量
添加变更日志条目：在变更日志章节顶部添加带日期的条目

变更日志条目格式：

markdown

undefined

YYYY-MM-DD - Added {Command Name} Command

Added:
```
/arckit.{name}
```
command ({N}th ArcKit command) for {description}
Added: {name} row and column to dependency matrix
Updated: Tier {X} {Tier Name} to include {name} command
Dependencies: {dep1} (M), {dep2} (R), {dep3} (O)
Consumed by: {consumer1} (M/R/O), {consumer2} (M/R/O)

undefined

Added:
```
/arckit.{name}
```
command ({N}th ArcKit command) for {description}
Added: {name} row and column to dependency matrix
Updated: Tier {X} {Tier Name} to include {name} command
Dependencies: {dep1} (M), {dep2} (R), {dep3} (O)
Consumed by: {consumer1} (M/R/O), {consumer2} (M/R/O)

undefined

7. docs/WORKFLOW-DIAGRAMS.md

If the new command fits into existing workflow paths, add it to the relevant Mermaid diagrams. See references/dependency-matrix-format.md for Mermaid node format and style colors.

Not all commands need to appear in workflow diagrams. Skip if the command is a utility (customize, pages) or doesn't fit the sequential workflow model.

若新命令适合加入现有工作流路径，将其添加至相关Mermaid图中。Mermaid节点格式和样式颜色请查看references/dependency-matrix-format.md。

并非所有命令都需要出现在工作流图中。若为工具类命令（如customize、pages）或不符合顺序工作流模型，可跳过此步骤。

8. docs/README.md

Add a row to the Documentation Coverage table and update the coverage count:

markdown

| `/arckit.{name}` | [{name}.md](guides/{name}.md) | Complete |

Insert alphabetically or in the same position as other files in its category. Update the coverage line:

markdown

**Coverage**: {N}/{N} commands documented (100%)

在文档覆盖度表格中添加一行，并更新覆盖数量：

markdown

| `/arckit.{name}` | [{name}.md](guides/{name}.md) | Complete |

按字母顺序或同分类其他文件的位置插入。更新覆盖度行：

markdown

**Coverage**: {N}/{N} commands documented (100%)

9. CLAUDE.md

Update if needed:

Command count references: Search for "50 commands" or similar counts
Multi-instance types list: If the new command supports multi-instance documents (like ADR, DIAG, WARD, DMC, DFD), add it to the multi-instance list in the
```
generate-document-id.sh
```
section
Agent System table: If the command delegates to an agent, add it to the agent table

按需更新：

命令数量引用：搜索"50 commands"或类似数量表述
多实例类型列表：若新命令支持多实例文档（如ADR、DIAG、WARD、DMC、DFD），将其添加至
```
generate-document-id.sh
```
章节的多实例列表中
Agent系统表格：若命令委托给Agent处理，将其添加至Agent表格中

10. CHANGELOG.md (root - CLI changelog)

10. CHANGELOG.md（根目录 - CLI变更日志）

Add an entry under a new or existing version section:

markdown

undefined

在新的或现有版本章节下添加条目：

markdown

undefined

Added

```
/arckit.{name}
```
command for {description}

undefined

```
/arckit.{name}
```
command for {description}

undefined

11. arckit-claude/CHANGELOG.md (plugin changelog)

11. arckit-claude/CHANGELOG.md（插件变更日志）

Add an entry under a new or existing version section:

markdown

undefined

在新的或现有版本章节下添加条目：

markdown

undefined

Added

```
/arckit.{name}
```
command for {description}

undefined

```
/arckit.{name}
```
command for {description}

undefined

Guide Creation

指南创建

docs/guides/{name}.md

doesn't exist, create one based on an existing guide as a template. Good templates to copy from:

Simple command:
```
docs/guides/plan.md
```
or
```
docs/guides/adr.md
```

Research command:

docs/guides/research.md

docs/guides/aws-research.md

Compliance command:
```
docs/guides/principles-compliance.md
```
Operations command:
```
docs/guides/devops.md
```

A guide should contain:

Title and description
Prerequisites (which artifacts should exist first)
Usage examples with sample arguments
What the command produces (document type, filename pattern)
Tips and best practices

Remember to copy the guide to both

docs/guides/

and

arckit-claude/guides/

若

docs/guides/{name}.md

不存在，可基于现有指南创建。推荐参考以下模板：

简单命令：
```
docs/guides/plan.md
```
或
```
docs/guides/adr.md
```

研究类命令：

docs/guides/research.md

或

docs/guides/aws-research.md

合规类命令：
```
docs/guides/principles-compliance.md
```
运维类命令：
```
docs/guides/devops.md
```

指南应包含：

标题和描述
前置条件（需先存在哪些工件）
使用示例及参数示例
命令输出内容（文档类型、文件名格式）
提示与最佳实践

请记得将指南同时复制到

docs/guides/

和

arckit-claude/guides/

目录下。

Post-Update Verification

更新后验证

After completing all updates, verify no old counts remain:

Grep for old count: Search the entire repo for the old number pattern (e.g., "50 commands", "50 slash commands", "50 AI-assisted"). Any remaining matches are locations you missed.
Grep for new count: Verify the new count appears in all expected locations.
Check the command exists in: README.md table, docs/index.html card, docs/DEPENDENCY-MATRIX.md row/column, docs/README.md coverage table.

bash

undefined

完成所有更新后，验证是否仍存在旧数量：

搜索旧数量：在整个仓库中搜索旧数字的相关表述（例如："50 commands"、"50 slash commands"、"50 AI-assisted"）。任何匹配结果均为遗漏的更新位置。
搜索新数量：验证新数量是否出现在所有预期位置。
检查命令是否存在于：README.md表格、docs/index.html卡片、docs/DEPENDENCY-MATRIX.md行/列、docs/README.md覆盖度表格中。

bash

undefined

Example verification (replace 49 with old count, 50 with new count)

验证示例（将49替换为旧数量，50替换为新数量）

grep -rn "50 commands|50 slash commands|50 AI-assisted|50/50" README.md docs/index.html arckit-claude/.claude-plugin/plugin.json .claude-plugin/marketplace.json docs/README.md docs/DEPENDENCY-MATRIX.md

undefined

undefined

Run Converter

运行转换工具

After all documentation updates, regenerate Codex and Gemini formats:

bash

python scripts/converter.py

完成所有文档更新后，重新生成Codex和Gemini格式：

bash

python scripts/converter.py

References

参考资料

references/file-locations.md - Exact file paths, grep patterns, and insertion points
references/html-patterns.md - HTML command card template for docs/index.html
references/dependency-matrix-format.md - DSM format, changelog format, Mermaid diagram format

references/file-locations.md - 精确文件路径、grep匹配规则和插入位置
references/html-patterns.md - docs/index.html的HTML命令卡片模板
references/dependency-matrix-format.md - DSM格式、变更日志格式、Mermaid图格式