用途:创建结构化、可维护的最佳实践文档,覆盖从快速参考到详细指南的多种深度,适合团队或智能体建立参考材料与知识库。
主要能力:核心原则是把快速参考与完整文档分离。推荐目录结构为 best-practice-name/ 下含 SKILL.md(2-3页快速参考,供人快速浏览)、AGENTS.md(完整内容,供智能体阅读)和 rules/(模块化规则文件,每个文件聚焦一个主题)。SKILL.md 包含概述与核心原则、适用与不适用场景、快速参考表、关键模式代码、警示信号及完整文档链接;AGENTS.md 为单文档完整汇编,可由 rules/ 生成或编译;rules/ 便于独立更新。
使用方式:按需选择模式——快速查找用带规则文件链接的表格,深入理解用 AGENTS.md,特定主题用单个规则文件,代码变体用表格而非多个示例。每个规则文件应包含该模式为何重要、❌错误与✅正确示例对比、补充上下文与参考。
适用场景:编写技术最佳实践指南、为团队或智能体组织参考文档、构建结构化知识库、记录已验证的模式与方法。
限制:不适用于一次性文档(用简单 README)、项目专属笔记(用 CLAUDE.md)、叙事型博客或教程。应避免把所有内容塞进一个文件、省略快速参考、堆砌五种语言示例、使用叙事风格规则等反模式。
资料未提供具体安装命令、收费或平台信息。