GitHub連携で技術ドキュメントを自動生成
文章だけでなく、図解も生成可能
Codeledge上で編集履歴を一元管理
Facing these issues?
こんなお悩み、ありませんか？
仕様と実装の不一致
技術ドキュメントに書かれた仕様と
ソースコードの実装が一致せず、
チームが混乱している
品質のばらつき
プロジェクトメンバーごとに
表記・構成・深さが異なり、
技術ドキュメントの品質がバラバラ
Docs as Code未浸透
Docs as Codeの考えを
チームに浸透させたいが、
書式や記法がメンバーに根付かない
でも、改善する時間が無い…
メンバーの優先は開発業務で、
技術ドキュメントの作成は後回しになっている
ドキュメンテーションのガイドラインを
作成すべきだが、自分の業務で手一杯
で
技術ドキュメントの
生成・更新を自動化
Codeledgeで実現する
「効率化」と「標準化」
AIがソースコードを解析し、自動で文書化・図解化
ソースコード連動で最新化、履歴管理・外部共有も
開発者の手間を削減し、開発生産性を向上
人や時期に左右されない安定した品質を実現
全プロジェクトで同じルールをすぐに適用
最新のソースコードを反映し、信頼性を確保
3つのポイント
point01
技術ドキュメントを
自動で生成
リポジトリにコミットすると、
技術ドキュメントが自動で生成・更新されます。
point02
文章だけでなく図解も
自動で生成
詳細仕様書などの文章だけなく、
フローチャートやシーケンス図などの図解もソースコードを元に生成します。
point03
技術ドキュメントの
更新履歴を管理
技術ドキュメントごとに履歴を管理し、
誰が・いつ更新したか把握できます。
他サービスとの比較表
| 一般的な ドキュメント作成ツール | 一般的な生成AI | |
| 文書化・図解化の簡易性 |  ソースコードから自動生成 |  人手で作成 |  正確なプロンプト、コンテキストが必要 |
| 内容の一貫性 | ルールベースの解析と 検証済みプロンプトによる安定性 | 作業者によって質がまばら | プロンプト上の工夫が必要 |
| ソースコードとの同期 | ソースコード更新時に自動生成 | ソースコード更新時は 人手で修正が必要 | ソースコード更新時は 再度実行が必要 |
| ドキュメントの履歴管理 | AIによる自動生成、人による編集 ともに履歴を確認可能 | ドキュメントごとに 履歴を確認可能 | ドキュメントごとの 管理機能なし |
サービス利用の流れ
01会員登録
メールアドレスを登録します。
届いた本登録用のURLを開き、新規会員登録してください。
02GitHubと連携し、
リポジトリを登録
GitHubとCodeledgeを連携し、技術ドキュメントを自動生成したいソースコードのリポジトリをすべて選択します。
03サービス利用開始
ソースコードを変更してリポジトリにプッシュをするとCodeledgeが検知。AIがコードを解析し、テキストや図解などを生成・更新します。