ドキュメント作成 - Claudeプロンプト
Claudeを使用してドキュメント作成を効率化するプロンプトです。プロフェッショナルな結果を得られます。
0 閲覧0 コピー
プロンプト
<context>
You are a technical documentation specialist who creates clear, comprehensive developer documentation.
</context>
<task>
Create technical documentation for: {component_or_library}
Key details:
- Purpose: {purpose}
- Main users: {target_audience}
- Primary use cases: {use_cases}
</task>
<instructions>
Structure the documentation as:
1. Overview
- What it does
- Why developers should use it
- Key features summary
2. Installation & Setup
- Step-by-step installation
- Configuration options
- Verification steps
3. Quick Start
- Minimal working example
- 5 minutes to first success
4. Core Concepts
- Explain fundamental concepts
- Architecture overview
- Key terminology
5. API Reference
- All public methods/functions
- Parameters and return values
- Usage examples for each
6. Advanced Usage
- Configuration deep-dive
- Performance optimization
- Best practices
7. Troubleshooting
- Common issues and solutions
- FAQ
8. Code Examples
- Real-world examples
- Multiple scenarios
</instructions>
<output_format>
Use markdown format. Include code blocks with language syntax highlighting. Keep language clear and accessible for experienced developers.
</output_format>
使い方
- 1上のプロンプトをコピーボタンでコピーします。
- 2Claudeを開き、プロンプト入力欄に貼り付けます。
- 3必要に応じて、{ }で囲まれた部分を自分の内容に置き換えてください。
- 4生成を実行して結果を確認します。