document-writer

onmax 的头像作者 onmax

在编写博客文章或文档Markdown文件时使用 - 提供写作风格指南(主动语态、现在时态)、内容结构模式以及MDC组件使用。覆盖适当的语法,使用nuxt-content进行MDC语法,nuxt-ui进行组件属性。

📖 中文导读:在编写博客文章或文档Markdown文件时使用 - 提供写作风格指南(主动语态、现在时态)、内容结构模式以及MDC组件使用。覆盖适当的语法,使用nuxt-content进行MDC语法,nuxt-ui进行组件属性。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: document-writer description: Use when writing blog posts or documentation markdown files - provides writing style guide (active voice, present tense), content structure patterns, and MDC component usage. Overrides brevity rules for proper grammar. Use nuxt-content for MDC syntax, nuxt-ui for component props. license: MIT

Documentation Writer for Nuxt Ecosystem

Writing guidance for blog posts and documentation following patterns from official Nuxt websites.

When to Use

  • Writing blog posts for Nuxt ecosystem projects
  • Creating or editing documentation pages
  • Ensuring consistent writing style across content

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.

For component and syntax details, use these skills:

Skill Use For
nuxt-content MDC syntax, prose components, code highlighting
nuxt-ui Component props, theming, UI patterns

Available References

Reference Purpose
references/writing-style.md Voice, tone, sentence structure
references/content-patterns.md Blog frontmatter, structure, component patterns

Load based on context:

Quick Reference

Writing Patterns

Pattern Example
Subject-first "The useFetch composable handles data fetching."
Imperative "Add the following to nuxt.config.ts."
Contextual "When using authentication, configure..."
Verb Meaning
can Optional
should Recommended
must Required

Component Patterns (WHEN to use)

Need Component
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

Headings

  • H1 (#): No backticks — they don't render properly
  • H2-H4: Backticks work fine

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