SuperAPI AI 工具集

faq-driven-docs

写作与研究

查看项目

更新于 10-15 19:57

技能介绍

用途:以 FAQ 驱动开发的方式组织文档,把设计理由与使用方式分别压缩成问答,减少臃肿规格,方便维护者、应用开发者和智能体检索。

主要能力:维护两类文件,DESIGN_FAQ.md/.mdx 回答“为什么”,涵盖决策、权衡、性能与维护背景,按主题分组,格式为 Q: … / A: …,每个答案 2–3 句;DX_FAQ.md/.mdx 回答“怎么做”,聚焦 API 用法与模式,大型 API 推荐用 Memory Palace(emoji + 名称的空间位置,每处一个模式并内嵌代码块)。两者互补,同一事实不得重复,改为链接。

使用方式:仓库布局为包根目录下放 DESIGN_FAQ 与 DX_FAQ,加 .cursor/rules/faq_usage.mdc 路由规则,以及 .cursor/commands/ 下的 update-faq.md、use-faq-diagram.md、update-faq-packages.md。新包引导流程:先写 DESIGN_FAQ(5–15 个问答起步),再写 DX_FAQ,加规则与命令,并在父级 README 或 AGENTS.md 用路由表链接。代码变更后按类型更新:架构或内部权衡改 DESIGN_FAQ,公共 API 或用法改 DX_FAQ,新子包则建子包 FAQ 并在父级加指针。

适用场景:生产级 monorepo(如 ecsly)中按包维护文档;也可用于 .cursor/rules、AGENTS.md、ADR、代码注释等表面。

限制:答案需简短,长示例移到 references/ 或官方文档站;不要记录尚未实现的 API;优先编辑既有问答而非新增冗余条目;父级 FAQ 只做路由,不重复子包答案。安装命令:npx skills add arenukvern/skill_steward --skill faq-driven-docs。相关技能 concept-doc-store 可配合使用。