← 一覧へ
✍️ 文章・資料を書くCC / Codex 両対応難易度: 初心者
コードドキュメント作成 code-documentation
コードを分かりやすく解説しよう
これは何？
このスキルは、コードやプロジェクトのドキュメントを自動生成するためのものです。READMEファイルやAPIリファレンス、開発者向けガイドなど、様々な種類のドキュメントを作成できます。特にオープンソースプロジェクトやチーム開発で役立ちます。
これでできること
- プロジェクトのREADME.mdを自動生成できる
- コードからAPIリファレンスドキュメントを作成できる
- アーキテクチャ図付きの設計ドキュメントを生成できる
- 開発者向けの貢献ガイドを作成できる
- 変更履歴やリリースノートを自動生成できる
こんな時に便利
GitHubに公開するプロジェクトのREADMEを作りたい時
チームメンバー向けにAPI仕様書が必要な時
コードの保守性を高めるためにコメントを充実させたい時
新しいメンバーがプロジェクトに参加する際のオンボーディング資料が必要な時
バージョンアップ時の変更点をまとめたい時
使い方
まず「このコードのドキュメントを作成して」などと依頼してください。コードを分析して適切なドキュメントを提案します。READMEが必要か、APIリファレンスが必要か、プロジェクトの規模に応じて最適なドキュメントを生成します。生成後は必要に応じて内容を調整できます。
使用例（こう頼んでみよう）
このPythonスクリプトのREADMEを作成してくださいAPIのリファレンスドキュメントを生成してくださいプロジェクトのアーキテクチャ図付きの設計ドキュメントを作成してください変更履歴をコミットログから自動生成してください必要なもの
- 特になし
導入方法
いちばん簡単（AIに頼む）
次のスキルを入れて: https://github.com/bytedance/deer-flow/tree/main/skills/public/code-documentation手動で置く
Claude Code →
~/.claude/skills/code-documentation/Codex →
~/.agents/skills/code-documentation/使いこなしのコツ
- 具体的なターゲット読者（開発者、エンドユーザーなど）を指定するとより適切なドキュメントが生成できます
- 既存のドキュメントがある場合はそれを参考にしながら改善案を提案できます
- 生成後に必ず内容を確認し、プロジェクトに合わせて調整しましょう