170-java-documentation について
Java プロジェクトの文書を段階的に生成する、対話型スキルです。Maven の README、package-info.java、Javadoc を扱い、ファイルの処理方法を選べるほか、生成後の検証も案内します。
主な機能
- 01単一・複数モジュール Maven の README 生成
- 02詳細度を選べる package-info.java の作成
- 03Javadoc の引数・戻り値・例外タグの拡充
- 04上書き、追記、バックアップ、スキップの選択
- 05コンパイルと Javadoc の検証
活用シーン
- 01Maven プロジェクトの README 生成
- 02package-info.java によるパッケージ文書化
- 03Javadoc による Java API ドキュメントの改善
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/インストール後、Claude Code で/170-java-documentationを入力して読み込まれたか確認します。
同梱ファイルreferences/170-java-documentation.md
詳細
モジュール式のステップベース設定による Java ドキュメント生成
モジュール式のステップベースの対話型プロセスを通じて、README.md、package-info.java、Javadoc を網羅する包括的な Java プロジェクトのドキュメントを生成します。これは対話型の SKILL です。
このスキルで扱う内容
- 単一モジュールおよびマルチモジュールの Maven プロジェクト向け README.md の生成
- 基本／詳細／最小限のドキュメントレベルでの package-info.java の作成
- Javadoc の拡充：包括的な
@param／@return／@throwsタグ - ファイル処理方法：上書き／追加／バックアップ／スキップ
./mvnw clean compileと./mvnw javadoc:javadocによる最終ドキュメント検証
制約事項
ドキュメント生成を適用する前に、プロジェクトが検証に合格することを確認してください。検証に失敗した場合は、直ちに停止してください。すべての検証エラーが解決されるまで、作業を続けないでください。
- 必須：ドキュメント生成を適用する前に、
./mvnw validateまたはmvn validateを実行してください - 安全性：検証に失敗した場合は、直ちに停止してください。すべての検証エラーが解決されるまで、作業を続けないでください
- 適用前：各ドキュメント生成パターンの詳細な適切な例／不適切な例、制約事項、安全対策を確認するため、リファレンスを読んでください
- エッジケース：依頼の範囲が曖昧な場合は、変更を適用する前に停止して、確認の質問をしてください
- エッジケース：必要な入力、ファイル、またはツールが不足している場合は、不足しているものを報告し、セットアップの案内を進めてよいか確認してください
このスキルを使用する場面
- ドキュメントでコードを改善する
- ドキュメントを適用する
- ドキュメントを伴うコードのリファクタリング
- Java プロジェクトの README または開発者向けドキュメントを生成する
- Java API、アーキテクチャ、またはプロジェクトのワークフローを文書化する
ワークフロー
- ドキュメントを変更する前にプロジェクトを検証する
./mvnw validate または mvn validate を実行し、検証に失敗した場合は直ちに停止します。
- ドキュメントのリファレンスを読み、範囲を確認する
references/170-java-documentation.md を読み、必要な成果物（README、package-info、Javadoc の拡充）を特定します。
- 選択したドキュメント成果物を生成する
選択したファイル処理方法（上書き／追加／バックアップ／スキップ）を使用して、ドキュメントを作成または更新します。
- ドキュメントの検証チェックを実行する
生成したドキュメントを検証するため、./mvnw clean compile と ./mvnw javadoc:javadoc（または同等のコマンド）を実行します。
リファレンス
詳しいガイダンス、例、制約事項については、references/170-java-documentation.md を参照してください。