Back to Details

document-writer

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Documentation Writer for Nuxt Ecosystem

Nuxt生态系统文档撰写指南

Writing guidance for blog posts and documentation following patterns from official Nuxt websites.
遵循Nuxt官方网站的模式，为博客文章和文档提供撰写指导。

When to Use

适用场景

  • Writing blog posts for Nuxt ecosystem projects
  • Creating or editing documentation pages
  • Ensuring consistent writing style across content
  • 为Nuxt生态系统项目撰写博客文章
  • 创建或编辑文档页面
  • 确保内容间的写作风格一致

Writing Standard

写作标准

Override: When writing documentation, maintain proper grammar and complete sentences. The "sacrifice grammar for brevity" rule does NOT apply here.
Documentation must be:
  • Grammatically correct
  • Clear and unambiguous
  • Properly punctuated
  • Complete sentences (not fragments)
Brevity is still valued, but never at the cost of clarity or correctness.
特殊说明：撰写文档时，请保持语法正确和句子完整。“为简洁牺牲语法”的规则不适用于此。
文档必须满足：
  • 语法正确
  • 清晰明确
  • 标点规范
  • 句子完整（非片段）
简洁性仍值得重视，但绝不能以清晰度或正确性为代价。

Related Skills

相关技能

For component and syntax details, use these skills:
SkillUse For
nuxt-contentMDC syntax, prose components, code highlighting
nuxt-uiComponent props, theming, UI patterns
如需了解组件和语法细节，请使用以下技能：
技能用途
nuxt-contentMDC语法、散文组件、代码高亮
nuxt-ui组件属性、主题设置、UI模式

Available References

可用参考资料

ReferencePurpose
references/writing-style.mdVoice, tone, sentence structure
references/content-patterns.mdBlog frontmatter, structure, component patterns
参考资料用途
references/writing-style.md语态、语气、句子结构
references/content-patterns.md博客前置元数据、结构、组件模式

Loading Files

文件加载建议

Consider loading these reference files based on your task:
  • references/writing-style.md - if writing prose, improving voice/tone, or structuring sentences
  • references/content-patterns.md - if creating blog posts, setting up frontmatter, or using MDC components
DO NOT load all files at once. Load only what's relevant to your current task.
请根据任务加载相关参考文件：
  • references/writing-style.md - 若撰写散文、优化语态/语气或构建句子结构时使用
  • references/content-patterns.md - 若创建博客文章、设置前置元数据或使用MDC组件时使用
请勿一次性加载所有文件，仅加载与当前任务相关的文件。

Quick Reference

快速参考

Writing Patterns

写作模式

PatternExample
Subject-first"The 
useFetch
composable handles data fetching."
Imperative"Add the following to 
nuxt.config.ts
."
Contextual"When using authentication, configure..."
模式示例
主语优先"
useFetch
组合式函数用于处理数据获取。"
命令式"将以下内容添加至 
nuxt.config.ts
。"
情境化"使用身份验证时，请配置..."

Modal Verbs

情态动词

VerbMeaning
can
Optional
should
Recommended
must
Required
动词含义
can
可选
should
推荐
must
必须

Component Patterns (WHEN to use)

组件使用场景

NeedComponent
Info aside
::note
Suggestion
::tip
Caution
::warning
Required
::important
CTA
:u-button{to="..." label="..."}
Multi-source code
::code-group
For component props: see nuxt-ui skill
需求组件
信息提示框
::note
建议提示框
::tip
警告提示框
::warning
必填说明
::important
行动召唤按钮
:u-button{to="..." label="..."}
多源代码块
::code-group
如需了解组件属性：请查看 nuxt-ui 技能

Headings

标题规范

  • H1 (
    #
    )    : No backticks — they don't render properly
  • H2-H4: Backticks work fine
  • H1 (
    #
    )    ：请勿使用反引号——它们无法正常渲染
  • H2-H4：可以正常使用反引号

Checklist

检查清单

  • Active voice (85%+)
  • Present tense
  • 2-4 sentences per paragraph
  • Explanation before code
  • File path labels on code blocks
  • Appropriate callout types
  • No backticks in H1 headings
  • 主动语态占比85%以上
  • 使用一般现在时
  • 每段2-4句话
  • 先解释再展示代码
  • 代码块添加文件路径标签
  • 使用合适的提示框类型
  • H1标题中不使用反引号