document-writer
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.
- License 许可
- MIT
- 最近更新
- 2026-05-26
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- document-writer
- license
- MIT
- description
- 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.
03 SKILL.md 正文
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 | Voice, tone, sentence structure |
| references/content-patterns.md | Blog frontmatter, structure, component patterns |
Load based on context:
- Writing prose → references/writing-style.md
- Blog structure and patterns → 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
04 同仓库更多 Skills
vueuse
Use when working with VueUse composables - provides reactive utilities for state, browser APIs, sensors, network, animations. Check VueUse before writing custom composables - most patterns already implemented.
vue
Use when editing .vue files, creating Vue 3 components, writing composables, or testing Vue code - provides Composition API patterns, props/emits best practices, VueUse integration, and reactive destructuring guidance
vue-best-practices
Vue 3 and Vue.js best practices for TypeScript, vue-tsc, and Volar. This skill should be used when writing, reviewing, or refactoring Vue components to ensure correct typing patterns. Triggers on tasks involving Vue components, props extraction, wrapper components, template type checking, or Volar configuration.
ts-library
Use when authoring TypeScript libraries - covers project setup, package exports, build tooling (tsdown/unbuild), API design patterns, type inference tricks, testing, and release workflows. Patterns extracted from 20+ high-quality ecosystem libraries.
three-best-practices
Three.js performance optimization and best practices guidelines. Use when writing, reviewing, or optimizing Three.js code. Triggers on tasks involving 3D scenes, WebGL/WebGPU rendering, geometries, materials, textures, lighting, shaders, or TSL.
supabase-best-practices
Supabase security and performance guidelines with Clerk authentication integration. Contains 40+ rules across 10 categories covering RLS policies, Clerk setup, database security, and more.