document-writer
Nuxt 生态系统专用的技术文档写作助手,提供写作风格指南、MDC 组件使用模式与技术博客结构规范。
简介
document-writer 技能是一个专为 Nuxt.js 生态系统中的开发者与维护者设计的技术写作助手。它执行严格的清晰度与语法标准,确保技术内容既专业又与官方 Nuxt 文档模式一致。与优先考虑简洁性的通用写作工具不同,此技能要求使用完整句子与正式语法,非常适合用于高质量文档、API 指南与版本公告博客文章。
此技能与 Nuxt Content 及 Nuxt UI 生态系统深度整合。它引导用户正确实作 MDC (Markdown Components) 语法,确保技术说明能搭配正确的标注类型 (note, tip, warning, important) 与 UI 组件。它还支持博客文章的特定前置资料 (frontmatter) 结构,确保元数据与作者信息能正确处理以利 SEO 与呈现。
-
提供专业的写作风格指南,着重于主动语态、现在时态与明确的句子结构。
-
为 Nuxt 博客文章提供结构模式,包括前置资料模板与逻辑内容流。
-
管理 MDC 组件使用方式,包括代码高亮与 prose 组件整合。
-
根据特定的质量检查清单验证技术文档,包括 H1 格式规则与代码区块中的文件路径标记。
-
与 nuxt-content 及 nuxt-ui 技能协调,提供组件特定的文档与使用元数据。
-
定义特定的情态动词 (can, should, must) 以区分可选、推荐与必要的操作。
-
在撰写技术文档或 Nuxt 模块公告时使用此技能。
-
当需要调整语气、语调或句子结构时,加载 writing-style.md 参考文件。
-
在建立新博客文章或复杂的 MDC 文档结构时,加载 content-patterns.md 参考文件。
-
确保所有 H1 标题不包含反引号,以保证在 Nuxt Content 系统中能正确渲染。
-
优先遵循“先解释再放代码”的原则,以维护读者的上下文与清晰度。
-
用户应确保标注类型与其具体意图一致 (例如:使用 warning 表示重大变更,使用 important 表示必要设置步骤)。
仓库统计
- Star 数
- 648
- Fork 数
- 29
- Open Issue 数
- 3
- 主要语言
- TypeScript
- 默认分支
- main
- 同步状态
- 空闲
- 最近同步时间
- 2026年4月30日 08:11