跳到正文
cccskills
免费在 GitHub 公开

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.

中文简介正在准备中。当前显示原文说明。

查看安装方法

包含的文件(3)

  • SKILL.md3.7 KB
  • references/content-patterns.md4.3 KB
  • references/writing-style.md3.7 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

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:

SkillUse For
nuxt-contentMDC syntax, prose components, code highlighting
nuxt-uiComponent props, theming, UI patterns

Available References

ReferencePurpose
references/writing-style.mdVoice, tone, sentence structure
references/content-patterns.mdBlog frontmatter, structure, component patterns

Loading Files

Consider loading these reference files based on your task:

DO NOT load all files at once. Load only what's relevant to your current task.

Quick Reference

Writing Patterns

PatternExample
Subject-first"The useFetch composable handles data fetching."
Imperative"Add the following to nuxt.config.ts."
Contextual"When using authentication, configure..."

Modal Verbs

VerbMeaning
canOptional
shouldRecommended
mustRequired

Component Patterns (WHEN to use)

NeedComponent
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

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Add, update, or retire an AI provider model option for the BYOK theme generator (OpenAI, Anthropic, Google) and verify the provider requests native structured output for it. Use when model lists go stale or a new provider/model is requested.

中文简介正在准备中。当前显示原文说明。

mattycraig/nuxt-theme-builder92026年10月20日 更新

Add a new interactive design tool under /tools (like the color converter or contrast checker) — component, page, navigation, route lists, SEO, and tests. Use when building a new utility tool.

中文简介正在准备中。当前显示原文说明。

mattycraig/nuxt-theme-builder92026年10月20日 更新

Write and register a new Learning Hub article (Nuxt Content markdown under content/learn) with valid frontmatter, navigation entry, route list entry, and accurate product details. Use when adding or substantially rewriting a learn guide, reference, or tip.

中文简介正在准备中。当前显示原文说明。

mattycraig/nuxt-theme-builder92026年10月20日 更新

Add a new component showcase, block, or template preview page and register it everywhere it must appear (navigation, command palette, route lists, SEO, source view). Use when adding anything under /components, /blocks, or /templates.

中文简介正在准备中。当前显示原文说明。

mattycraig/nuxt-theme-builder92026年10月20日 更新

Checklist for adding or changing a field on ThemeConfig (a new design token, per-mode setting, or export option) end to end — schema, defaults, store + history, CSS apply, export, editor UI, AI, and tests. Use whenever ThemeConfig's shape changes.

中文简介正在准备中。当前显示原文说明。

mattycraig/nuxt-theme-builder92026年10月20日 更新

Run the project's validation pipeline (lint → format → typecheck → unit tests) with auto-fixes, then optionally stage and write a Conventional Commit. Use before committing, when asked to "check", "validate", "run the workflow", or "get this commit-ready".

中文简介正在准备中。当前显示原文说明。

mattycraig/nuxt-theme-builder92026年10月20日 更新

查看 mattycraig 的全部技能

报告此技能的问题