engineering-walkthrough-skill は何をしますか?
ソースコードに基づいたエンジニアリングウォークスルー文書を作成するCodexスキル
このスキルは、リポジトリ内のソースコードを解析し、それに基づいたエンジニアリングウォークスルー文書を生成します。開発者はこのスキルを使用して、コードベースの理解を深め、設計上の決定事項や重要な処理フローを明確に文書化できます。
用途
- コードベースの概要を説明するウォークスルー文書の自動作成
- チーム内のナレッジ共有の促進
- 新規メンバーのオンボーディングの効率化
動作環境
- Codex
- 対応言語: 任意のプログラミング言語
使用方法
Codexのスキルとして読み込み、リポジトリ内で実行します。スキルは指定されたソースコードを読み込み、解析結果をMarkdown形式で出力します。