マークダウン形式ドキュメントの作成、編集、校閲、レビューを支援する汎用スキル。READMEの作成、技術ドキュメントの執筆、文章の校正、構成改善、リンク検証、日本語・英語の文法チェック、一貫性確認、アクセシビリティ改善時に使用。ユーザーが「ドキュメントを書きたい」「READMEを作成」「文章をレビュー」「校閲して」「マークダウンを整形」「ドキュメントの改善」などをリクエストした際にトリガー。
マークダウン形式のドキュメント作成、編集、校閲、レビューを支援するスキル。
→ 「ドキュメント作成ワークフロー」へ
→ 「編集ワークフロー」へ
→ 「レビューワークフロー」へ
以下を確認する:
ドキュメント種類に応じた標準構成:
README
# プロジェクト名
## 概要
## 機能
## インストール
## 使い方
## 設定
## 開発
## ライセンス
技術仕様書
# タイトル
## 背景・目的
## 設計
## 実装詳細
## テスト方針
## 制限事項
APIドキュメント
# API名
## エンドポイント一覧
### GET /resource
#### リクエスト
#### レスポンス
#### エラー
各セクションを順番に執筆。ユーザーからのフィードバックを反映しながら進める。
内容追加: 既存の構成に合わせて追記
構成変更: セクションの順序や階層を調整
表現改善: 簡潔で明確な表現に修正
編集後の差分を確認し、意図通りの変更か検証。
ドキュメントを通読し、以下を確認:
詳細はレビューチェックリストを参照。
主要チェック項目:
問題点と改善提案を以下の形式で報告:
## レビュー結果
### 重要度: 高
- [具体的な問題と改善案]
### 重要度: 中
- [具体的な問題と改善案]
### 重要度: 低（推奨）
- [具体的な問題と改善案]
#の後にスペース