SuperAPI AI 工具集

literate-guide

写作与研究

查看项目

更新于 10-16 08:03

技能介绍

用途:literate-guide 用于把一个代码库、某个功能或用一组改动写成“文学编程”风格的叙事指南(Literate Programming,Knuth 提出)。核心思路是:程序被阅读的次数远多于被编写,因此不按文件树或执行顺序组织,而按人理解概念的先后顺序来呈现,让代码片段出现在叙事中恰需要它的位置。

主要能力:输出为单篇 Markdown 叙事文档,包含编号小节(用 § 符号,如 §1、§2)、代码摘录、交叉引用(§N)与 Mermaid 图(如系统总览、时序图)。强调散文承担主要解释工作,代码是理解实现的窗口;把“为什么这样设计”作为一等内容,记录备选方案、取舍与约束。

使用方式:技能内含工作流。第一步确认范围,询问指南覆盖整个代码库、特定功能/子系统,还是最近改动或 PR,并确认目标读者(新加入的开发者、做架构评审的资深工程师、未来的自己、开源贡献者);若代码库超过 50 个文件,建议收窄到子系统。第二步深读代码,依次调查问题、领域模型、架构、主流程、设计决策与 git 历史。第三步确定叙事主线:开篇动机、理解推进的弧线、3-5 个关键设计选择、按概念命名的小节。第四步按 references/guide-template.md 模板写作。第五步自查叙述连贯性、代码摘录必要性、设计理由和交叉引用正确性。第六步交付为单个 Markdown 文件,建议路径为 .claude/docs/literate-guide.md 或 .claude/docs/literate-guide-{feature}.md,并说明节数与主题。

适用场景:为团队新成员撰写代码库导读、为架构评审整理设计依据、为开源项目提供贡献者入门材料、为个人记录易忘系统细节。

限制:示例询问与选项、模板路径、交付路径均来自技能资料;实际使用依赖具体 AI 工具环境,资料未提供安装命令、平台要求、价格或效果保证。资料未提及对语言、代码库规模或输出字数的硬性限制。