SuperAPI AI 工具集

writing-docs

写作与研究

查看项目

更新于 10-16 00:22

技能介绍

用途:该技能用于编写和更新 Medusa 的 MDX 文档,涉及 www/apps/ 下的 book、resources、ui、user-guide 和 cloud 项目,依据文档变更需求产出内容。

主要能力:按项目规范撰写或修改 MDX 文档,维护各项目的侧边栏文件;支持跨项目链接语法(如 !docs!、!resources!、!user-guide!);要求写作前至少加载一个参考文件,如决定是否需要文档用 reference/when-to-document.md,写 MDX 用 reference/mdx-patterns.md,各项目风格用 reference/book-style.md、resources-style.md、user-guide-style.md、cloud-style.md,检查行文质量用 reference/vale-rules.md。

必要用法与结构:MDX 文件至少包含导出 metadata(title)和 # {metadata.title};book 页面使用章节编号时标题写为 ${pageNumber} Chapter Title。各项目内容路径与侧边栏文件:book 为 www/apps/book/app/ 与 sidebar.mjs;resources 为 www/apps/resources/app/ 与 sidebars/*.mjs;ui 为 www/apps/ui/app/、www/apps/ui/specs/examples/ 与 sidebar.mjs;user-guide 为 www/apps/user-guide/app/ 与 sidebar.mjs;cloud 为 www/apps/cloud/app/ 与 sidebar.mjs。新增页面需加入对应侧边栏。

限制:不得记录带 @ignore 标签的选项、方法或参数;不得触碰自动生成的 www/apps/resources/references/ 与 www/apps/ui/specs/components/,也不得触碰由独立流程管理的 www/apps/api-reference/;不得运行 yarn prep 或 yarn lint:content;不得虚构 Cloudinary 截图 URL,应留 <!-- TODO: add screenshot -->;新增选项、方法或参数需加版本说明;行文避免 we/us/let's/our、被动语态、e.g.、em dash,代码行不超过 64 字符,使用 “Medusa backend” 而非 “Medusa API”,不使用 HTML。仅可记录公开 API,不写内部实现细节。