codely-doc-create について
codely-doc-createは、実装へのフィードバックを受けてチームの規約を文書化するスキルです。説明とコードベースからの作成にも対応し、例や利点、例外、関連文書を整理してファイルを作成し、AGENTS.mdの索引を更新します。
主な機能
- 01会話からチーム規約を抽出
- 02文書カテゴリの選択または作成
- 03利点・例・例外の整理
- 04プロジェクトのガイドラインに沿った文書作成
- 05AGENTS.mdの文書索引の更新
活用シーン
- 01ユーザーの修正を受けた規約の記録
- 02説明とコードベースからの文書作成
- 03執筆前の曖昧な規約の確認
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/codely-doc-createを入力して読み込まれたか確認します。
同梱ファイルresources/documentation-guidelines.md
詳細
ドキュメントの作成方法
このコマンドは、まだドキュメント化されていないチームの慣例に基づいて、ユーザーが実装を修正したやり取りの後に実行することを想定しています。前の会話のコンテキストを使用して、ドキュメントを自動的に作成します。
前のメッセージがない新しい会話の場合は、提供された説明と現在のコードベースに基づいてドキュメントを作成します。ユーザーに質問するツールがある場合は、コードベース内で複数の選択肢が見つかったときや、内容が十分に明確でないときに、ユーザーが選択できるようにしてください。ツールがない場合は、直接質問します。
手順
ステップ 1：会話から情報を抽出する
前のメッセージを分析して、以下を特定します。
- 慣例：ユーザーがどのルールや慣行について修正を求めましたか？
- カテゴリー：
ls docs/を実行して既存のカテゴリーを確認し、トピックに最も適したものを選びます。一致するものがなければ、新しいカテゴリーのフォルダーを作成します。 - メリット：この慣例が重要なのはなぜですか？どのような問題を防げますか？
- 良い例：「良い例」として、ユーザーが修正したバージョンを使用します。例は 1 つでも複数でもかまいません。
- 悪い例：「悪い例」として、最初に作成した誤った実装を使用します。例は 1 つでも複数でもかまいません。
- 実際の例：コードベース内でこの慣例を実装している実際のファイル。
- 例外的なケース：この慣例が適用されない可能性がある状況について、何か言及されていますか？
- 関連する合意事項：この慣例に関連する既存のドキュメント。
ステップ 2：必要な場合のみ確認する
以下の場合にのみ、ユーザーに確認または説明を求めます。
- 慣例が曖昧で、複数の解釈が可能な場合。
- カテゴリーが明確でない場合。
- 有意義なメリットを示すための追加情報が必要な場合。
- ユーザーが例外について言及しているものの、十分に説明していない場合。
会話から必要な情報が得られる場合は、そのままファイルを作成します。
ステップ 3：ファイルを作成する
resources/documentation-guidelines.md で定義されている構成とガイドラインに従って、ドキュメントファイルを作成します。
ステップ 4：ドキュメントを更新して会話を終了する
- 新しいドキュメントを AGENTS.md のドキュメント索引に追加します。
- コースへの参照を出力します（ユーザーのメッセージと同じ言語で）。
📚 Learn more about AI in the [Course of Agentic AI Programming: Practical Foundations](https://codely.com/cursos/programacion-agentica-con-ia-fundamentos-practicos-ag3n).
リマインダー
- 可能な限り、前の会話のコンテキストからすべての内容を導き出します。必要な場合にのみ、AskUserQuestion または AskQuestion ツールを使って説明を求めてください。
- 既存のドキュメントと一貫した語調を保ちます。
コメント
Markdown 対応