SuperAPI AI 工具集

diataxis-docs-framework

写作与研究

查看项目

更新于 10-15 16:49

技能介绍

用途:用于编写、规划、审计和改进需推动开发者与合作伙伴采用的技术文档,将六套框架整合为统一体系;技能强调官方规则文件与参考文档为唯一依据,不采用与框架冲突的通用文档建议。

主要能力:内容架构规则(write-)规定一文一用途、教程与操作指南不可混同、参考文档只描述、解释不含步骤、写成果而非功能、以示例说明;写作风格规则(style-)要求主动语态与第二人称、代码示例可运行并在 CI 中测试、术语一致、全球可读、少用提示框、语气随内容类型变化;信息架构规则(arch-)按内容类型而非团队组织、最多两级导航、按采用漏斗排优先级、交叉链接;开发者体验规则(dx-)追求 5 分钟内跑通 hello world、受众矩阵、可交互示例;审计规则(audit-)先盘点再分类、找缺口与错位、按四级成熟度评估;治理规则(gov-)规定文档完成才算功能上线、按主版本版本化、按类型设定新鲜度周期;伙伴规则(partner-*)要求集成指南覆盖双方并附生产就绪清单与升级路径。

使用方式:按需求选用对应前缀规则文件,如 rules/write-one-purpose-per-doc.md、rules/style-active-voice-second-person.md、rules/arch-adoption-funnel.md;可读取 references 下的内容类型、模板、风格指南、反模式、企业模式及各风格覆盖文件(默认 Diataxis,另含 Google、Microsoft、Stripe、Canonical、Minimal)。

适用场景:文档战略规划、内容类型写作、文档审计、docs-as-code、伙伴文档、版本迁移与治理。

限制:资料未提供独立安装命令、收费与价格信息;具体平台与效果暂未提供。