SuperAPI AI 工具集

wiki-init

写作与研究

查看项目

更新于 10-23 16:16

技能介绍

用途

wiki-init 用于为当前代码仓库生成首版(initial)OpenWiki 文档,输出到仓库内的 openwiki/ 目录。文档同时面向人类读者和后续的编码智能体,目标是建立一个准确、可导航的快速入门与分节页面结构。

主要能力

  • 生成 openwiki/quickstart.md 作为入口,再补充少量聚焦的分节页面。
  • 基于源码证据写作:先读取本技能目录下的 references/core.md,遵循其中的质量规则、结构要求、安全规则以及 AGENTS.md/CLAUDE.md 引用模板。
  • 收集 git 上下文,包括 git status --short、git rev-parse HEAD、git log --max-count=20 --name-status --oneline 和 git diff --name-status HEAD,用于理解仓库当前状态与近期演进。
  • 盘点仓库资产:现有文档、应用入口、包/配置文件、主要领域目录、测试/评估、数据/schema 文件、技能/剧本文件、运维脚本等;多领域仓库可使用只读研究子代理。
  • 在写作前制定计划,计划只保留在工作笔记或仓库外的临时文件中,不写入 openwiki/。
  • 若仓库已有大量文档,则把 wiki 定位为有观点的地图与综合层,而非重复内容。
  • 复查 openwiki/ 目录树,合并、移动或删除低价值的单文件目录和空壳页面。
  • 更新根目录 AGENTS.md/CLAUDE.md,加入 core.md 中规定的标准 OpenWiki 引用段。
  • 在 openwiki/.last-update.json 记录运行元数据,其中 "command": "init"。
  • 结束时汇报所创建的文档及重要注意事项或未决问题。

使用方式

通过调用该技能对当前仓库执行首次文档生成。首次运行假定 openwiki/ 尚无有用文档,从零构建结构。若调用时用户附带额外指令,这些指令在上述规则范围内优先。页面规模保持聚焦:quickstart 加解释仓库所需的最小分节页面集合,除非仓库明显很小,否则最多 8 页。完成首版后即停止,后续可由 /wiki-update 运行继续完善。

适用场景

  • 需要快速为新仓库或缺乏文档的仓库建立可导航文档。
  • 希望文档基于 git 历史与源码证据,并可作为后续编码智能体的上下文起点。
  • 已有较多文档、需要一层有观点的综合与导航地图。

限制

  • 不追求记录每一个源文件,只覆盖主要架构、工作流、领域概念、数据模型、集成、运维、测试和已知扩展点。
  • 计划文件不得留在 openwiki/ 内。
  • 安装方式、支持的平台、版本信息与收费情况资料暂未提供。