document-writer

The document-writer skill acts as a specialized technical writing assistant designed specifically for developers and maintainers within the Nuxt.js ecosystem. It enforces a strict standard for clarity and grammar, ensuring that technical content is both professional and consistent with official Nuxt documentation patterns. Unlike general writing tools that prioritize brevity over syntax, this skill mandates the use of complete sentences and formal grammar, making it ideal for high-quality documentation, API guides, and release blog posts.

The skill integrates deeply with the Nuxt Content and Nuxt UI ecosystems. It guides users in the correct implementation of MDC (Markdown Components) syntax, ensuring that technical explanations are paired with the correct callout types (note, tip, warning, important) and UI components. It also supports the use of specific frontmatter structures for blog posts, ensuring metadata and author information are handled correctly for SEO and presentation.

• Provides professional writing style guidance focusing on active voice, present tense, and unambiguous sentence structure.

• Offers structural patterns for Nuxt blog posts, including frontmatter templates and logical content flow.

• Manages MDC component usage, including code highlighting and prose component integration.

• Validates technical documentation against specific quality checklists, including H1 formatting rules and file-path labeling in code blocks.

• Coordinates with the nuxt-content and nuxt-ui skills to provide component-specific documentation and usage metadata.

• Defines specific modal verbs (can, should, must) to distinguish between optional, recommended, and required actions.

• Use this skill when drafting documentation markdown files or technical announcements for Nuxt modules.

• Load the writing-style.md reference when you need to refine tone, voice, or sentence construction.

• Load the content-patterns.md reference when setting up new blog posts or complex MDC document structures.

• Ensure all H1 headings remain free of backticks to guarantee proper rendering in Nuxt Content-based systems.

• Prioritize the 'Explanation before code' pattern to maintain reader context and clarity.

• Users should always verify that callout types align with their specific intent (e.g., using warning for breaking changes or important for required setup steps).