Back to Documentation & Writing

document-writer

documentationwritingnuxtblog postscontent creationmarkdownstyle guidetechnical writing
682🕒 2026-06-01Source ↗

Install this skill

npx skills add onmax/nuxt-skills

Works across Claude Code, Cursor, Codex, Copilot & Antigravity

The document-writer skill provides a specialized framework for generating high-quality documentation and blog content consistent with official Nuxt ecosystem standards. It enforces strict grammatical precision, prohibiting the common AI habit of sacrificing sentence structure for brevity. By prioritizing clear, unambiguous prose and standardized structural patterns, this tool ensures that technical content remains accessible and authoritative. Users can generate blog posts, setup guides, or configuration tutorials that adhere to specific Nuxt conventions, such as proper H1 heading formatting and the correct application of callout components. Whether detailing a new feature or explaining complex composables, the agent maintains an active voice and present tense, ensuring your technical manuals meet the professional requirements expected of the Nuxt framework and its surrounding community projects.

When to Use This Skill

  • Drafting technical blog posts for Nuxt-related projects
  • Authoring documentation for custom Vue composables or plugins
  • Updating legacy README or documentation files to match official project patterns
  • Creating tutorials that integrate Nuxt Content and MDC syntax

How to Invoke This Skill

Example prompts that trigger this skill in Claude Code, Cursor, or Antigravity:

  • Draft a documentation page for this new composable
  • Write a blog post about our latest Nuxt integration following project standards
  • Refactor this documentation section to meet Nuxt style guidelines
  • Explain this configuration step using proper MDC callouts
  • Draft a guide for installing our project, ensuring professional grammar

Pro Tips

  • 💡Always explicitly state the target audience for your document; this helps the skill tailor its tone, complexity, and examples appropriately.
  • 💡When incorporating Nuxt-UI components, provide a high-level description of the desired UI element and its purpose, not just the component name, for optimal usage guidance.
  • 💡For complex technical explanations, break them down into smaller, logical sections and ask the skill to elaborate on each part sequentially to maintain clarity and focus.

What this skill does

  • Enforces strict adherence to Nuxt ecosystem writing standards
  • Validates grammatical accuracy and full-sentence structure
  • Applies standardized callout components like ::note, ::tip, and ::warning
  • Generates content using the required H1, H2, and H3 heading constraints
  • Maintains active voice and present tense throughout technical guides

When not to use it

  • Writing creative fiction or non-technical marketing copy
  • Generating short-form social media updates where brevity outweighs formal grammar

Example workflow

  1. Define the technical scope and audience for the documentation
  2. Trigger the agent to draft the content using the specified tone guidelines
  3. Review the generated text for proper H1 and H2 heading formatting
  4. Insert appropriate callout components like ::tip or ::warning where needed
  5. Verify that all code blocks include necessary file path labels
  6. Finalize the document with a grammatical check for active voice

Prerequisites

  • Access to the project's content structure
  • Basic knowledge of Nuxt Content (MDC) syntax

Pitfalls & limitations

  • !Using backticks in H1 tags, which prevents proper rendering
  • !Over-relying on sentence fragments which violates the grammar mandate
  • !Ignoring the specific callout types defined for Nuxt-UI and Nuxt-Content

FAQ

Why does this skill forbid backticks in H1 headings?
Backticks in H1 headings interfere with standard Markdown-to-HTML rendering processes in Nuxt, so they are restricted to maintain layout integrity.
Does this skill prioritize brevity over grammar?
No. While it values concise writing, it strictly prohibits sacrificing grammatical correctness or complete sentence structure to achieve brevity.
How do I decide between using ::note or ::tip?
Use ::note for general information and ::tip when offering a specific recommendation or performance-enhancing suggestion.

How it compares

Unlike generic writing prompts that often produce vague or grammatically loose text, this skill forces strict adherence to official Nuxt writing standards, ensuring every document is ready for production deployment without manual style correction.

Source & trust

682 stars🕒 Updated 2026-06-01
📄 Full skill instructions — original source: onmax/nuxt-skills
# 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:

| 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](references/writing-style.md)** | Voice, tone, sentence structure |
| **[references/content-patterns.md](references/content-patterns.md)** | Blog frontmatter, structure, component patterns |

**Load based on context:**

- Writing prose → [references/writing-style.md](references/writing-style.md)
- Blog structure and patterns → [references/content-patterns.md](references/content-patterns.md)

## 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..." |

### Modal Verbs

| 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

How to Use This Skill Unit

Option A: Project-Specific (Recommended)

  1. Click "Download" above
  2. In your project, create the directory: .agent/skills/document-writer/
  3. Save the file as SKILL.md
  4. The agent will automatically discover the skill based on its description.

Option B: Global Installation (All Agents)

Save the file to these locations to make it available across all projects:

  • Claude Code: ~/.claude/skills/onmax/nuxt-skills/document-writer/SKILL.md
  • Cursor: ~/.cursor/skills/onmax/nuxt-skills/document-writer/SKILL.md
  • Antigravity: ~/.gemini/antigravity/skills/onmax/nuxt-skills/document-writer/SKILL.md

🚀 Install with CLI:
npx skills add onmax/nuxt-skills

Read the Master Guide: Mastering Agent Skills

Related Skill Units

Recommended Rules

View more rules

Recommended Workflows

View more workflows

Recommended MCP Servers

View more MCP servers

Take It Further

Maximize your productivity with these powerful resources

📋

Define Your Standards

Set up coding standards to ensure this workflow produces consistent, high-quality results.

Browse Rules Library
📖

Master Workflows

Learn how to create custom workflows, use Turbo Mode, and build your automation library.

Complete Guide

How to use this Skill in Claude Code & Cursor

For Claude Code (CLI)

To use this skill in Claude Code, copy the rule content into your project's custom instructions or follow our Add-Skill CLI guide. This ensures Claude follows your standards during every code generation.

For Cursor & Windsurf

For Cursor or Windsurf, individual skills are best used in the "Rules for AI" section. This specific unit helps the agent avoid documentation & writing issues, leading to cleaner, more efficient code.

Why the skill format matters: the standardized Agent Skills format lets your AI agent load detailed instructions only when they are relevant, keeping your prompt clean while improving results.

Source & attribution

This skill is categorized under Documentation & Writing and is published by Onmax, maintained in onmax/nuxt-skills.

← Browse All Agent Skills
Sponsored AI assistant. Recommendations may be paid.