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.

Related Skills

For component and syntax details, use these skills:

Available References

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.

Quick Reference

Writing Patterns

Modal Verbs

Component Patterns (WHEN to use)

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