用途:该技能面向 AI 编程助手,用于撰写或维护文档与博客 Markdown 文件。适用时机包括新增插件、功能或选项,修改插件行为或 API 签名,修复影响代码生成的缺陷,编写或更新 functionalities/component/composable 文档,以及为搜索引擎优化文档。
主要能力:产出清晰、简洁、实用的文档,优化开发者体验;按搜索引擎与开发者意图组织内容;提升可扫读性与参与度。写作标准要求语法正确、清晰无歧义、标点规范、使用完整句子;此处不适用“为简短牺牲语法”的规则,简洁仍被重视,但不得牺牲清晰与正确。
参考文件按场景加载:writing-style.md 用于行文语气与句式;content-patterns.md 用于用法、props 结构与组件模式;seo-optimization.md 用于标题、描述、关键词与 FAQ;humanizer.md 用于审阅或编辑成稿,去除 AI 写作痕迹并增加具体细节。
语言与命名:使用美式拼写(如 license 而非 licence);文件名用 kebab-case,如 how-to-do-thing.md;命名需具描述性,如 multipart-form-data.md 而非 form.md;文件名对应 URL 路径。
写作模式:主语前置、祈使句、结合上下文表述。情态动词含义:can 表示可选,should 表示推荐,must 表示必需。组件模式:NOTE 用于信息提示,TIP 用于建议,WARNING 用于警告,IMPORTANT 用于必需项;多来源代码使用 ::: code-group 并以 ::: 结束。标题方面 H1 不加反引号,H2-H4 可用反引号。链接使用相对路径与锚点,外部链接用完整 URL 和描述性文字,链接区置于文末。图片存放于 docs/public/,用相对路径引用,采用 webp/png/jpg 等优化格式并控制体积,命名具描述性。
检查清单:主动语态占比 85% 以上、使用现在时、每段 2-3 句、先解释后代码、校验 frontmatter 语法、执行 humanizer 处理。限制:资料未提供安装命令、收费与平台信息。