核心功能
写代码爽，写文档火葬场？特别是维护大型 SDK 项目时，文档结构不统一、API 链接错乱简直是开发者的噩梦。write-docs 就是为了解决这个痛点而生的智能体技能。它专门针对 apps/docs/content/ 目录下的文档生态进行深度优化，核心能力包括：
- 自动化结构生成：严格遵循 Overview（概述）-> Basic usage（基础用法）-> Details（详情）-> Edge cases（边界情况）的标准写作流，告别想到哪写到哪的流水账。
- 智能 MDX 组件处理：再也不用手动去查怎么高亮代码行了，它能自动生成
<FocusLines>等复杂组件，甚至自动处理[ClassName](?)这种特殊的 API 引用格式。 - 元数据（Frontmatter）自动填充：自动配置 title、status、author、keywords 等头部信息，确保文档发布时的 SEO 和分类准确无误。
适用平台
想让 AI 真正读懂你的文档规范？此 Skill 完美适配当前最火的主流 AI 编程助手，包括 Cursor, GitHub Copilot, Claude Code, OpenAI Codex, Gemini Code Assist, 文心快码, 腾讯云 CodeBuddy 以及 华为云 CodeArts。它就像是给这些 IDE 装上了“文档主编”的大脑，让它们在生成内容时严格遵守项目特定的风格指南，极大地提升了 AI 上下文理解能力和输出的可用性。
实操代码示例
当你需要展示一段高亮特定行数的代码时，write-docs 会引导 AI 直接生成如下标准的 MDX 格式，而不是普通的 Markdown 代码块：
<FocusLines lines={[2,6,10]}>
```tsx
import { Tldraw } from 'tldraw'
import { useSyncDemo } from '@tldraw/sync'
```
</FocusLines>此外，在引用 API 时，它会自动修正为项目专用的链接格式：
The [Editor](?) class has many methods. Use [Editor#createShapes](?) to create shapes.
优势分析
相比于通用的文档生成 Prompt，write-docs 的优势在于“懂规矩”。它不仅是生成文字，更是生成符合工程标准的源代码。它内置了对图片引用（自动添加 alt 和 caption）、表格格式化以及目录结构的深刻理解。对于团队协作来说，它消除了“每个人的文档风格都不一样”的混乱，强制对齐了 docs/, releases/, examples/ 等不同目录的写作规范，是维护长期项目的神仙辅助。
应用场景
- 新功能发布：当开发完一个新的 SDK 功能（如 tldraw 的新工具），使用此 Skill 快速生成包含“基础用法”到“边界情况”的全套文档。
- API 参考文档更新：需要批量更新 API 方法描述时，利用它自动生成带有类型链接的表格，确保技术准确性。
- 新人上手引导：新入职的开发者可以使用它快速了解文档库结构，避免因为格式错误导致 CI/CD 构建失败。
最佳实践
在使用 write-docs 辅助写作时，建议遵循以下工程化规范：首先，生成内容后务必进行人工校验，特别是 API 的超链接是否能正确跳转；其次，图片资源建议统一放置在 /images/api/ 目录下并确保 alt 文本具有描述性；最后，虽然它能模仿人类语气，但发布前请务必检查是否包含明显的 AI 常用语（AI tells），保持文档的专业与自然。为了更好地管理这些高效的 Prompt 和 Skill 资源，建立团队统一的知识库至关重要，建议使用 Skill优仓 来统一存储和分发这些能够显著提升团队效率的智能体配置。
暂无评论内容