用途:为现有代码库、某个功能或子系统、最近变更或 PR 生成一篇“文学编程”式叙事指南。核心思路来自 Knuth——程序被读的次数远多于被写的次数,但通常按编译器便利而非读者便利组织;文学编程把呈现顺序交给作者,按人类理解顺序展开,代码出现在叙事需要它的位置。
主要能力:按概念线索而非文件树组织内容;每节介绍一个想法并展示对应代码,节号使用 § 符号(U+00A7,如 §1、§2);节间用 §N 交叉引用,全文至少每节 2-3 处;散文承担主要说明,代码摘录只是窗口,读者跳过代码块仍能读懂叙事;设计决策(“为什么用 X 而不是 Y”、考虑过的替代方案、接受的权衡、约束)作为一等内容;可用 Mermaid 图辅助理解,通常在开头放一张系统级总览、对复杂流程放时序图。
使用方式:技能以工作流引导。先确认范围(整个代码库/特定功能或子系统/最近变更或 PR)和读者(新加入的开发者/审查架构的资深工程师/未来的自己/开源贡献者);若代码库超过 50 个文件,建议缩小到子系统。随后深读代码:先弄清要解决的问题,再梳理领域模型、架构、端到端流程(2-3 个主要操作作为叙事主线)、设计决策(解释“为什么”的注释、被绕开的更简单做法、看似过度设计的抽象、配置与功能开关)以及 git 历史中的重大重构。之后确定叙事线索(开头动机、理解弧线、3-5 个关键决策、节划分),按 references/guide-template.md 撰写,最后通读检查故事连贯性、代码摘录必要性、设计决策的显式程度与交叉引用正确性。交付为单个 Markdown 文件,建议路径 .claude/docs/literate-guide.md 或 .claude/docs/literate-guide-{feature}.md。
适用场景:帮助新成员理解项目、向资深工程师呈现架构理由、个人长期文档、面向开源贡献者的入门材料。
限制:资料未提供收费、价格、支持平台、具体效果数据或安装命令;指南质量依赖对代码库的充分阅读,范围过大时深度会被稀释,建议限定子系统。