document-writer_skill

Overview

This skill helps authors write blog posts and documentation for the Nuxt ecosystem. It enforces an active, present-tense writing style, clear structure patterns, and recommended MDC component usage. It integrates guidance for nuxt-content prose and nuxt-ui component props.

How this skill works

The skill inspects draft text and recommends edits for voice, tense, grammar, and paragraph length. It suggests page structure patterns, frontmatter fields, and when to apply MDC callouts and components. It flags H1 usage rules, code block labels, and explains component choices with nuxt-ui prop examples when relevant.

When to use it

• Writing or editing Nuxt blog posts
• Creating or updating documentation pages
• Converting notes into structured MDC markdown
• Ensuring consistent style across a docs site
• Preparing examples that use nuxt-content or nuxt-ui patterns

Best practices

• Prefer active voice and present tense across at least 85% of sentences
• Write complete sentences and prioritize clarity over extreme brevity
• Limit paragraphs to 2–4 sentences with an explanation before code examples
• Label code blocks with file paths and use ::code-group for multi-source code
• Use MDC callouts for intent: ::note, ::tip, ::warning, ::important, and u-button for CTAs

Example use cases

• Create a Nuxt composable guide that explains behavior, shows code, and uses ::note for caveats
• Draft a migration doc that lists steps, links components, and uses :u-button for upgrade CTA
• Write a blog post with frontmatter, structured headings, and code blocks labeled with file paths
• Build a component reference page that shows props via nuxt-ui patterns and examples using ::code-group