document-writer について
Nuxtエコシステムのブログ記事やドキュメントを作成する人向けのライティングスキルです。公式サイトに沿った文体や構成の指針と、文章・ページ構成の参考資料を提供します。
主な機能
- 01Nuxtのライティング基準
- 02ブログとドキュメントの構成例
- 03文法と明確さのチェックリスト
- 04文体とコンテンツの参考資料
活用シーン
- 01Nuxtエコシステムのブログ記事作成
- 02ドキュメントページの作成や編集
- 03文章の明確さと一貫性の確認
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/document-writerを入力して読み込まれたか確認します。
同梱ファイルreferences/content-patterns.mdreferences/writing-style.md
詳細
Nuxt エコシステム向けドキュメントライター
Nuxt の公式サイトのパターンに沿ってブログ記事やドキュメントを執筆するためのガイダンスです。
使用する場面
- Nuxt エコシステムのプロジェクト向けにブログ記事を執筆する
- ドキュメントページを作成または編集する
- コンテンツ全体で一貫した文体を保つ
執筆基準
例外：ドキュメントを執筆するときは、適切な文法と完全な文を維持してください。「簡潔さのために文法を犠牲にする」というルールは適用されません。
ドキュメントは次の条件を満たす必要があります。
- 文法的に正しい
- 明確で曖昧さがない
- 適切に句読点を付けている
- 断片ではなく、完全な文である
簡潔さも大切ですが、明確さや正確さを損なってはいけません。
関連スキル
コンポーネントや構文の詳細については、次のスキルを使用してください。
| スキル | 用途 |
|---|---|
| nuxt-content | MDC 構文、文章用コンポーネント、コードのハイライト |
| nuxt-ui | コンポーネントの props、テーマ設定、UI パターン |
利用可能なリファレンス
| リファレンス | 目的 |
|---|---|
| references/writing-style.md | 文体、トーン、文の構成 |
| references/content-patterns.md | ブログの frontmatter、構成、コンポーネントのパターン |
ファイルの読み込み
タスクに応じて、次のリファレンスファイルを読み込むことを検討してください。
- references/writing-style.md - 文章の執筆、文体やトーンの改善、または文の構成を行う場合
- references/content-patterns.md - ブログ記事の作成、frontmatter の設定、または MDC コンポーネントの使用を行う場合
すべてのファイルを一度に読み込まないでください。 現在のタスクに関連するものだけを読み込んでください。
クイックリファレンス
執筆パターン
| パターン | 例 |
|---|---|
| 主語を先に置く | 「useFetch コンポーザブルはデータの取得を処理します。」 |
| 命令形 | 「nuxt.config.ts に次の内容を追加してください。」 |
| 文脈を示す | 「認証を使用する場合は、次のように設定します……」 |
助動詞
| 助動詞 | 意味 |
|---|---|
can | 任意 |
should | 推奨 |
must | 必須 |
コンポーネントのパターン（使用する場面）
| 必要なもの | コンポーネント |
|---|---|
| 補足情報 | ::note |
| 提案 | ::tip |
| 注意 | ::warning |
| 必須事項 | ::important |
| CTA | :u-button{to="..." label="..."} |
| 複数ソースのコード | ::code-group |
コンポーネントの props については、nuxt-ui スキルを参照してください。
見出し
- H1（
#）：バッククォートを使わないでください。正しく表示されません。 - H2〜H4：バッククォートを使用できます。
ワークフロー
- 関連するリファレンスファイルを読み込みます（文章については writing-style.md、構成については content-patterns.md）。
- 能動態と現在形を使って下書きを作成します。
- 以下のチェックリストを使って品質を確認します。項目に不備があれば修正し、再確認します。
- コールアウトの種類が意図（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 @nuxtjs/better-auth
~~~
The module auto-imports the `useUserSession` composable. Access the current user session from any component.
チェックリスト
- 能動態（85% 以上）
- 現在形
- 1 段落につき 2〜4 文
- コードの前に説明を置く
- コードブロックにファイルパスのラベルを付ける
- 適切な種類のコールアウトを使う
- H1 見出しにバッククォートを使わない
コメント
Markdown 対応