本文へ移動
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(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

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

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

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年9月29日 更新

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年9月29日 更新

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年9月29日 更新

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年9月29日 更新

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年9月29日 更新

Audit websites for SEO, performance, security, technical, content, and 15 other issue cateories with 230+ rules using the squirrelscan CLI. Returns LLM-optimized reports with health scores, broken links, meta tag analysis, and actionable recommendations. Use to discover and asses website or webapp issues and health.

日本語の概要は準備中です。原文の説明を表示しています。

mattycraig/nuxt-theme-builder92026年9月29日 更新

mattycraig のスキルをすべて見る

このスキルの問題を報告する