Nuxt エコシステム向けドキュメントライター

Nuxt の公式ウェブサイトのパターンに従った、ブログ記事とドキュメントの執筆ガイダンス。

使用時機

• Nuxt エコシステムプロジェクト向けのブログ記事執筆
• ドキュメントページの作成または編集
• コンテンツ全体での執筆スタイルの統一

執筆基準

上書き: ドキュメント執筆時は、適切な文法と完全な文を維持してください。「簡潔さのために文法を犠牲にする」ルールはここでは適用されません。

ドキュメントは以下を満たす必要があります:

• 文法的に正しい
• 明確で曖昧でない
• 適切に句読点が付いている
• 完全な文である（断片的でない）

簡潔さも価値がありますが、明確さと正確さを損なうことは決してありません。

関連スキル

コンポーネントと構文の詳細については、以下のスキルを使用してください:

スキル	用途
nuxt-content	MDC 構文、prose コンポーネント、コード強調表示
nuxt-ui	コンポーネント props、テーマ、UI パターン

利用可能なリファレンス

リファレンス	目的
references/writing-style.md	文体、トーン、文構造
references/content-patterns.md	ブログ frontmatter、構造、コンポーネントパターン

ファイルのロード

タスクに基づいて、これらのリファレンスファイルをロードすることを検討してください:

• references/writing-style.md - 文章執筆、文体/トーン改善、または文構造の構成を行う場合
• references/content-patterns.md - ブログ記事の作成、frontmatter のセットアップ、または MDC コンポーネントの使用時

すべてのファイルを一度にロードしないでください。 現在のタスクに関連するもののみをロードしてください。

クイックリファレンス

執筆パターン

パターン	例
主語優先	"The useFetch composable handles data fetching."
命令形	"Add the following to nuxt.config.ts."
文脈的	"When using authentication, configure..."

法動詞

動詞	意味
can	任意
should	推奨
must	必須

コンポーネントパターン (使用時機)

要件	コンポーネント
情報の注釈	::note
提案	::tip
注意	::warning
必須	::important
CTA	:u-button{to="..." label="..."}
複数ソースのコード	::code-group

コンポーネント props については: nuxt-ui スキルを参照してください

見出し

• H1 (#): バッククォートなし — 正しくレンダリングされません
• H2-H4: バッククォートは問題ありません

ワークフロー

1. 関連するリファレンスファイルをロード (文章用は writing-style.md、構造用は content-patterns.md)
2. 能動態と現在時制を使用してコンテンツを下書きする
3. 以下のチェックリストを適用して品質を検証し、項目に失敗した場合は修正して再確認する
4. 見出しのタイプが意図と一致していることを確認 (note/tip/warning/important)

例

# Getting Started with Authentication

Nuxt Better Auth provides a simple way to add authentication to your application.
Configure the module in your `nuxt.config.ts` to get started.

::note
Authentication requires a database connection. See the [database setup](/docs/database) guide for details.
::

## Installation

Add the module to your project:

~~~bash [Terminal]
pnpm add @onmax/nuxt-better-auth
~~~

The module auto-imports the `useUserSession` composable. Access the current user session from any component.

チェックリスト

• 能動態 (85%以上)
• 現在時制
• 1 段落あたり 2～4 文
• コードの前に説明
• コードブロックにファイルパスラベル
• 適切な見出しタイプ
• H1 見出しにバッククォートなし