ArcKit /arckit:story实战:八章节叙事自动生成项目完整历史档案
【免费下载链接】arc-kitThe Enterprise Architecture Governance Harness — strategy, architecture, delivery, and assurance using AI coding assistants项目地址: https://gitcode.com/GitHub_Trending/ar/arc-kit
在 ArcKit 企业架构治理框架中,/arckit:story命令只需输入一个项目 ID,就能自动把散落在项目目录里的几十份文档"读"一遍,生成一份 2000~3000 行的完整项目历史档案:八章节叙事、时间线甘特图、追踪链、治理成果,全部由 AI 根据 Git 历史自动撰写。本文带你完整走一遍这个命令的实战流程,适合刚接触 ArcKit 的新手。
什么是 /arckit:story:一句话讲清项目的一生
/arckit:story是 ArcKit 中的"项目故事生成器",输出文件为projects/<项目号>/ARC-<项目号>-STORY-v1.0.md。官方定位为:
项目的叙事性历史——适用于门禁评审材料(gate packs)、项目复盘和知识转移。
也就是说,你不再需要手动翻会议记录、拼 PPT、写总结。命令会自动扫描项目下的所有工件(原则、干系人、风险、商业论证、需求、采购、设计评审、合规评估……),从 Git 提交历史中提取时间线,然后按固定模板自动生成一份"有头有尾"的项目传记。
命令的完整逻辑定义在 plugins/arckit-claude/commands/story.md,用户指南在 docs/guides/story.md,最终成品的骨架则来自 plugins/arckit-claude/templates/story-template.md。
前置条件:先有"故事素材",才有好故事
一个有质量的项目故事至少需要 3~5 份工件。如果你在项目里已经跑过/arckit:principles(架构原则)、/arckit:stakeholders(干系人分析)、/arckit:requirements(需求定义)这类命令,素材就足够了。
| 检查项 | 说明 | 缺失时怎么办 |
|---|---|---|
| PRIN 架构原则 | 必需,位于projects/000-global/ | 先运行/arckit:principles |
| STKE / RISK / SOBC 等 | 推荐,干系人、风险、商业论证 | 补跑对应命令 |
| Git 提交历史 | 时间线的最佳数据源 | 无 Git 时自动回退到文件修改时间 |
💡 如果项目工件太少,命令会主动提醒你:"这个项目只有 N 份工件,建议先运行更多 ArcKit 命令,或接受一份精简版故事。"
一键运行:三种调用方式
# 按项目名 /arckit:story Cabinet Office GenAI # 按项目编号 /arckit:story 009 # 不带参数,让 AI 列出所有项目供你选择 /arckit:story运行后你会在终端看到一份"执行摘要":项目总时长、工件数量、每周命令速率、各阶段耗时占比、关键治理成果清单——而完整的 2000~3000 行档案已经静静躺在projects/009-xxx/ARC-009-STORY-v1.0.md里。
八章节叙事:故事是怎么写出来的
生成档案中最精彩的部分是八章节叙事,覆盖项目从立项到交付的完整生命周期(见 docs/guides/story.md 中的结构表):
- Foundation 基础—— 架构原则、干系人分析、风险登记
- Business Case 商业论证—— SOBC 战略大纲商业论证、数据模型
- Requirements 需求—— BR/FR/NFR 需求定义
- Research 研究—— 技术选型、Build vs Buy 决策
- Procurement 采购—— SOW 工作说明书、供应商评估
- Design 设计评审—— HLD/DLD 两级评审,含判定结果(通过/有条件通过/拒绝)
- Delivery 交付规划—— 用户故事、冲刺排期、运维设计
- Compliance 合规—— 服务评估、Secure by Design、AI Playbook
其中设计评审与交付规划两章是"深度叙事章":不只罗列发生了什么,还会写时间背景(该阶段耗时、占项目总时长百分比)、关键决策点、发现与结论、追踪链,读起来像一篇复盘报告而不是流水账。每章质量都经过质量清单校验,例如故事类文档要求"叙事结构清晰、有明确的开头、中段和结尾,突出关键指标,并包含经验教训章节"(见 plugins/arckit-claude/references/quality-checklist.md)。
时间线分析:四视图 + 真实数据
/arckit:story对时间线的处理是它的杀手锏。命令会优先解析Git 日志(提交时间戳、提交信息里的命令名、变更文件),把整个项目还原成一条带日期的事件流,然后生成:
| 可视化 | 内容 | 用途 |
|---|---|---|
| 甘特图(Mermaid Gantt) | 各阶段任务条 + 真实日期 | 看节奏、找瓶颈 |
| 命令流程图 | 每条命令节点标注执行日期 | 看执行顺序 |
| 事件明细表 | 日期、距项目启动天数、命令、工件 | 审计级细节 |
| 阶段耗时饼图 | 各阶段时间占比 | 快速定位投入分布 |
再配合时间线指标表(总时长、最长/最短阶段、每周命令速率、首个工件耗时等)和经验教训(节奏分析、关键路径、偏差对比、速度指标),这份档案可以直接拿去做季度组合汇报或项目关闭归档。
端到端追踪链:从干系人诉求到冲刺
故事的"硬核"证据是完整追踪链。命令会自动把六条链路画成 Mermaid 流程图并统计覆盖率:
- 干系人目标 → 业务需求
- 需求 → 架构设计
- 需求 → 供应商选择
- 需求 → 用户故事 → 冲刺
- 数据模型 → 数据需求 → CMDB
- 需求 → 合规评估
示例档案中的覆盖率可达 98%,每一环都有真实数量支撑(如"8 个干系人 → 12 个目标 → 15 个成果 → 23 条 BR → 45 条 FR")。这正是治理评审时最有说服力的部分:每个交付物都能回溯到一个干系人诉求。
再次运行:版本自动递增,绝不覆盖
项目还在演进?放心重跑。命令检测到已存在ARC-*-STORY-v*.md时会自动处理版本(见 docs/guides/story.md):
- 内容刷新(更新指标、修正细节)→ 小版本递增,如 1.0 → 1.1
- 范围实质变化(新增阶段、重大成果)→ 大版本递增,如 1.0 → 2.0
并自动在 Revision History 中记录变化,旧版档案不会被覆盖。官方建议的再生成时机:门禁评审、季度汇报、项目关闭、重大变更重置。
什么时候该用 /arckit:story
| 场景 | 用途 |
|---|---|
| 门禁评审(Discovery→Alpha 等) | 一键生成进度与证据摘要 |
| 季度组合汇报 | 提供一致的高管视图 |
| 项目关闭归档 | 沉淀知识,供未来团队查阅 |
| 新人入职 | 用叙事方式快速了解项目全貌 |
使用小贴士:
- 分享前记得对敏感信息做脱敏(见 docs/guides/story.md 的评审清单)
- 外部参考资料(PDF 报告、调研记录)放到
projects/{项目}/external/目录后再运行,档案会自动引用并生成引用追踪 - 模板可按团队习惯定制:项目根目录放
.arckit/templates/story-template.md即可覆盖默认模板
总结
/arckit:story把"项目总结"这件苦差事变成了一条命令的事:八章节叙事、四视图时间线、端到端追踪链、治理成果清单,全部基于真实工件和 Git 历史自动生成,并带自动版本管理。项目结束时,你得到的不是一份 PPT,而是一份 2000~3000 行、可审计、可追溯的完整历史档案——这也是 ArcKit "治理即生成"理念的最佳注脚。
【免费下载链接】arc-kitThe Enterprise Architecture Governance Harness — strategy, architecture, delivery, and assurance using AI coding assistants项目地址: https://gitcode.com/GitHub_Trending/ar/arc-kit
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考