关于 openwiki-init
openwiki-init 是一项技能，可在仓库的 `openwiki/` 中创建首轮、便于浏览的文档。它引导编码 Agent 调研仓库、规划并撰写页面、检查文档结构，以及更新 Agent 指令和运行元数据。
主要功能
- 01检查 Git 历史和仓库状态
- 02盘点代码、文档、测试及运维内容
- 03规划精简的 Wiki 页面集合
- 04撰写快速入门页及关联页面
- 05检查 Wiki 结构并记录运行元数据
适用场景
- 01为仓库创建首轮文档
- 02为人类和后续编码 Agent 梳理代码库
- 03将现有文档整合为 Wiki
安装
复制下面的命令，在终端中运行。
npx skills add https:/安装后在 Claude Code 中输入/openwiki-init确认已加载。
附带文件references/core.md
详细介绍
Wiki 初始化
为此代码库生成第一版文档，存放在 openwiki/ 下，供人类读者和后续编码 Agent 使用。
首先，阅读此技能目录中的 references/core.md——其中定义了所有输出都必须遵循的质量规则、结构要求、安全规则，以及 AGENTS.md/CLAUDE.md 参考模板。
这是一次初始文档生成：假设 openwiki/ 中尚无有用文档，从头构建文档结构。如果用户在调用时提供了其他指示，则在这些规则允许的范围内优先遵循。
工作流程
-
收集 Git 上下文。 运行
git status --short、git rev-parse HEAD、git log --max-count=20 --name-status --oneline和git diff --name-status HEAD，了解代码库的当前状态和近期演进。 -
构建代码库清单： 梳理现有文档、应用入口、软件包／配置文件、主要领域目录、测试／评估、数据／架构文件、技能／操作手册文件以及运维脚本。遵循 core.md 中的发现规范；如果代码库包含多个重要领域，则使用只读研究子 Agent。结合 Git 证据（近期提交，以及针对高信号文件的定向
git blame／git show）了解重要工作流的演变。 -
先制定计划，再开始撰写。 起草计划，列出拟编写的 Wiki 页面、每页的来源证据，以及尚待解答的问题。将计划保存在代码库之外：记在工作笔记中，或放在代码库之外的临时文件中（例如环境提供的临时目录）；切勿将计划文件留在
openwiki/中。页面集合应保持精简：快速入门，以及清晰说明代码库所需的最少章节页面；除非代码库明显很小，否则最多不超过 8 页。 -
撰写文档。 首先创建
openwiki/quickstart.md，然后创建链接到的章节页面。如果代码库已有大量文档，应将 Wiki 编写成具有观点的索引与综合说明层，而不是重复已有内容。无需记录每个源文件；应以恰当的详细程度涵盖主要架构、工作流、领域概念、数据模型、集成、运维、测试和已知扩展点。 -
检查目录树。 按照 core.md 中的章节质量规则重新检查
openwiki/目录树：合并、移动或删除价值较低的单文件目录和占位页面。 -
更新根目录 Agent 指令文件（
AGENTS.md／CLAUDE.md），加入 core.md 中的 OpenWiki 参考章节原文。 -
记录运行元数据到
openwiki/.last-update.json，其中"command": "init"（格式参见 core.md）。
完成时，总结创建的文档以及任何重要的注意事项或未解决问题。创建准确、易于浏览的第一版 Wiki，然后停止——后续可通过 /openwiki-update 运行进一步完善。