Document Writer

1---2name: document-writer3description: 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.4license: MIT5---6 7# Documentation Writer for Nuxt Ecosystem8 9Writing guidance for blog posts and documentation following patterns from official Nuxt websites.10 11## When to Use12 13- Writing blog posts for Nuxt ecosystem projects14- Creating or editing documentation pages15- Ensuring consistent writing style across content16 17## Writing Standard18 19**Override**: When writing documentation, maintain proper grammar and complete sentences. The "sacrifice grammar for brevity" rule does NOT apply here.20 21Documentation must be:22 23- Grammatically correct24- Clear and unambiguous25- Properly punctuated26- Complete sentences (not fragments)27 28Brevity is still valued, but never at the cost of clarity or correctness.29 30## Related Skills31 32For component and syntax details, use these skills:33 34| Skill            | Use For                                         |35| ---------------- | ----------------------------------------------- |36| **nuxt-content** | MDC syntax, prose components, code highlighting |37| **nuxt-ui**      | Component props, theming, UI patterns           |38 39## Available References40 41| Reference                                                            | Purpose                                         |42| -------------------------------------------------------------------- | ----------------------------------------------- |43| **[references/writing-style.md](references/writing-style.md)**       | Voice, tone, sentence structure                 |44| **[references/content-patterns.md](references/content-patterns.md)** | Blog frontmatter, structure, component patterns |45 46## Loading Files47 48**Consider loading these reference files based on your task:**49 50- [ ] [references/writing-style.md](references/writing-style.md) - if writing prose, improving voice/tone, or structuring sentences51- [ ] [references/content-patterns.md](references/content-patterns.md) - if creating blog posts, setting up frontmatter, or using MDC components52 53**DO NOT load all files at once.** Load only what's relevant to your current task.54 55## Quick Reference56 57### Writing Patterns58 59| Pattern       | Example                                            |60| ------------- | -------------------------------------------------- |61| Subject-first | "The `useFetch` composable handles data fetching." |62| Imperative    | "Add the following to `nuxt.config.ts`."           |63| Contextual    | "When using authentication, configure..."          |64 65### Modal Verbs66 67| Verb     | Meaning     |68| -------- | ----------- |69| `can`    | Optional    |70| `should` | Recommended |71| `must`   | Required    |72 73### Component Patterns (WHEN to use)74 75| Need              | Component                         |76| ----------------- | --------------------------------- |77| Info aside        | `::note`                          |78| Suggestion        | `::tip`                           |79| Caution           | `::warning`                       |80| Required          | `::important`                     |81| CTA               | `:u-button{to="..." label="..."}` |82| Multi-source code | `::code-group`                    |83 84> For component props: see **nuxt-ui** skill85 86## Headings87 88- **H1 (`#`)**: No backticks — they don't render properly89- **H2-H4**: Backticks work fine90 91## Workflow92 931. Load relevant reference file ([writing-style.md](references/writing-style.md) for prose, [content-patterns.md](references/content-patterns.md) for structure)942. Draft content using active voice and present tense953. Apply the checklist below to verify quality — if any item fails, revise and re-check964. Verify callout types match intent (note/tip/warning/important)97 98## Example99 100```md101# Getting Started with Authentication102 103Nuxt Better Auth provides a simple way to add authentication to your application.104Configure the module in your `nuxt.config.ts` to get started.105 106::note107Authentication requires a database connection. See the [database setup](/docs/database) guide for details.108::109 110## Installation111 112Add the module to your project:113 114~~~bash [Terminal]115pnpm add @onmax/nuxt-better-auth116~~~117 118The module auto-imports the `useUserSession` composable. Access the current user session from any component.119```120 121## Checklist122 123- [ ] Active voice (85%+)124- [ ] Present tense125- [ ] 2-4 sentences per paragraph126- [ ] Explanation before code127- [ ] File path labels on code blocks128- [ ] Appropriate callout types129- [ ] No backticks in H1 headings