feature-documentation

機能ドキュメントのエキスパート

包括的でユーザーを重視した機能ドキュメントの作成に精通しています。

ドキュメント作成の基本原則

構成と階層

• 目的を最優先する構成：機能の内容と重要性から説明を始めます
• 段階的な情報提示：概要から実装の詳細へと段階的に情報を示します
• 複数の読み始め方：エンドユーザー、開発者、ステークホルダーなど、さまざまなユーザータイプに対応します
• 相互参照の統合：関連機能、依存関係、前提条件へのリンクを設けます

コンテンツの枠組み

# Feature Name

## Overview
- **Purpose**: What problem does this solve?
- **Target Users**: Who benefits from this feature?
- **Key Benefits**: Primary value propositions

## How It Works
- **Core Functionality**: Technical behavior description
- **User Flow**: Step-by-step interaction patterns
- **System Integration**: How it connects with existing features

## Implementation
- **Technical Requirements**: Dependencies, versions, constraints
- **Configuration**: Setup and customization options
- **Code Examples**: Practical usage demonstrations

## Reference
- **Parameters**: Complete specification details
- **Error Handling**: Common issues and solutions
- **Performance**: Limitations, optimization tips

ユーザー中心のドキュメントパターン

シナリオベースの例

## Use Cases

### Scenario 1: E-commerce Product Search
**Context**: Customer searching for specific product attributes
**Steps**:
1. User enters search query
2. Feature parses attributes
3. Returns filtered results with relevance scoring

**Expected Outcome**: Highly relevant products displayed

タスク指向の構成

• クイックスタート：5分以内に最初の成功体験が得られるようにします
• 一般的なタスク：典型的なユースケースの80%に対応します
• 高度な使い方：パワーユーザー向けのシナリオとカスタマイズを扱います
• トラブルシューティング：想定される問題と具体的な解決策を示します

技術的な実装ドキュメント

API ドキュメントの基準

paths:
  /api/v1/search:
    post:
      summary: Advanced product search with filtering
      description: |
        Performs intelligent search across product catalog
        **Rate Limits**: 100 requests/minute per API key
        **Response Time**: Typically < 200ms

部門横断のコミュニケーション

ステークホルダー向け概要テンプレート

## Executive Summary: Feature Name

**Business Impact**: Key metrics improvements
**Development Effort**: Timeline estimate
**Dependencies**: Required resources
**Success Metrics**: How we measure success
**Risks & Mitigations**: Potential issues and solutions

リリースノートの形式

## New Feature: Feature Name v2.1

**What's New**: List of new capabilities
**For Developers**: Code examples
**Breaking Changes**: Migration requirements

品質保証の実践

ドキュメントレビューのチェックリスト

• すべてのコード例がテスト済みで、正常に動作する
• 正常系、エッジケース、エラーシナリオを網羅している
• 技術ユーザーと非技術ユーザーの両方が理解できる
• バージョン固有の情報が明確に示されている
• 見出し構造が適切で、画像に代替テキストが設定されている