product-documentation について
製品ドキュメントを作成するチーム向けのスキルです。ユーザーガイド、リリース資料、リファレンスを対象とし、明確で読者に合わせた文章や、例と図を含む構成の基準を示します。
主な機能
- 01ユーザーガイドの必須項目
- 02リリース・移行ドキュメント
- 03リファレンス資料の仕様
- 04明確で能動的な読者向けの文章
- 05例や図を含むページ構成
活用シーン
- 01製品ドキュメント一式の計画
- 02機能ガイドやトラブルシューティングの作成
- 03リリースノートや移行ガイドの準備
- 04設定項目や CLI コマンドの文書化
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ hack23/ homepage --skill product-documentationインストール後、Claude Code で/product-documentationを入力して読み込まれたか確認します。
詳細
プロダクトドキュメントスキル
目的
プロダクトのドキュメントを明確で包括的な、ユーザー重視の内容にし、ユーザーが機能を理解し、問題を解決して、プロダクトを最大限に活用できるようにします。
ルール
ドキュメントの種類
ユーザーガイド(必須):
- はじめに
- 機能ドキュメント
- トラブルシューティングガイド
- FAQ
- 用語集
リリースドキュメント:
- リリースノート(新機能、バグ修正、破壊的変更)
- 移行ガイド
- アップグレード手順
- 非推奨化のお知らせ
リファレンスドキュメント:
- 機能仕様
- 設定オプション
- キーボードショートカット/CLI コマンド
- システム要件
執筆基準
必須:
- 明確で簡潔な表現を使う
- 対象読者の技術レベルに合わせて書く
- 能動態を使う(「保存をクリックします」。 「保存がクリックされるべきです」ではなく)
- ビジュアルを含める(スクリーンショット、図、動画)
- 例を示す
- プロダクトの最新状態を反映する
構成:
# Feature Name
## Overview
[What it does and why it's useful]
## Prerequisites
[What users need before starting]
## How to Use
### Step 1: [Action]
[Detailed instructions with screenshots]
### Step 2: [Action]
[More instructions]
## Examples
[Real-world use cases]
## Troubleshooting
[Common problems and solutions]
## Related
[Links to related documentation]
例
機能ドキュメントのテンプレート
# Email Notifications
## Overview
Receive automatic email alerts when important events occur in your account.
## Setting Up Notifications
1. Go to **Settings** → **Notifications**
2. Toggle the events you want to be notified about
3. Verify your email address
4. Click **Save Preferences**
## Available Notification Types
- **Security Alerts**: Login attempts, password changes
- **System Updates**: Maintenance windows, feature releases
- **Account Activity**: Billing changes, user additions
## Troubleshooting
**Problem**: Not receiving notifications
**Solution**: Check spam folder, verify email address
## Related
- [Email Configuration](./email-config.md)
- [Security Settings](./security.md)
関連ポリシー
関連ドキュメント
コメント
Markdown 対応