Communityコーディング&開発github.com

DarrenHoo-10/engineering-walkthrough-skill

ソースコードに基づいたエンジニアリングウォークスルー文書を作成するCodexスキル

engineering-walkthrough-skill とは?

このスキルは、ソースコードやリポジトリの内容を分析し、エンジニアリングウォークスルー文書を自動生成するためのCodexスキルです。開発者がコードベースを理解しやすくするために、コードの構造や設計意図、重要なロジックを中心に解説した文書を作成します。主にCodex環境で動作し、CLI操作やファイルの読み込み・解析を通じて機能します。このスキルは特に、チーム内での知識共有や新規メンバーのオンボーディングを効率化する目的に適しており、コードの変更に応じてドキュメントを更新することで、常に最新の状態を保つことができます。

対応~Claude Code✓Codex CLI~Cursor
npx skills add DarrenHoo-10/engineering-walkthrough-skill

Installed? Explore more コーディング&開発 skills: steipete/bluebubbles, steipete/eightctl, steipete/blucli · View all 6 →

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

engineering-walkthrough-skill は何をしますか?

ソースコードに基づいたエンジニアリングウォークスルー文書を作成するCodexスキル

このスキルは、リポジトリ内のソースコードを解析し、それに基づいたエンジニアリングウォークスルー文書を生成します。開発者はこのスキルを使用して、コードベースの理解を深め、設計上の決定事項や重要な処理フローを明確に文書化できます。

用途

  • コードベースの概要を説明するウォークスルー文書の自動作成
  • チーム内のナレッジ共有の促進
  • 新規メンバーのオンボーディングの効率化

動作環境

  • Codex
  • 対応言語: 任意のプログラミング言語

使用方法

Codexのスキルとして読み込み、リポジトリ内で実行します。スキルは指定されたソースコードを読み込み、解析結果をMarkdown形式で出力します。

関連スキル