Usagi ユーザーガイド
Usagiは、レガシーシステムのソースコードをAIが解析・可視化する次世代プラットフォームです。既存のソースコードから自動的に設計書やドキュメントを生成し、システムの理解とリプレイスを支援します。
すぐに始める
初めての方は、はじめにガイドをご覧ください。30分程度で最初のドキュメント生成を体験できます。
主な機能
ソースコードのアップロード
ZIPファイル形式でソースコードをアップロードするだけで、AIがコードベースを解析します。
AI解析による自動ドキュメント生成
アップロードされたソースコードから、AIが自動的に各種ドキュメントを生成します。
12種類のドキュメントタイプ
Usagiでは、以下の12種類のドキュメントを生成できます：
- ソフトウェア方式設計書 - システム全体のアーキテクチャと構成を記述
- 基本設計書 - 機能要件と基本的な設計方針を記述
- 詳細設計書 - 各モジュールの詳細な実装設計を記述
- API仕様書 - APIのエンドポイント、パラメータ、レスポンスを記述
- コーディング規 約 - プロジェクト固有のコーディングスタイルとルールを記述
- 単体テスト計画書 - ユニットテストの方針と範囲を記述
- 単体テスト仕様書 - 各ユニットテストの詳細な仕様を記述
- 結合テスト計画書 - 統合テストの方針と範囲を記述
- 結合テスト仕様書 - 各統合テストの詳細な仕様を記述
- システムテスト計画書 - システムテスト全体の方針と範囲を記述
- システムテスト仕様書 - 各システムテストの詳細な仕様を記述
- ユーザーガイド - エンドユーザー向けの操作マニュアルを記述
対応環境・制限事項
- 対応言語: Python, Java, C++, Go, JavaScript/TypeScript(Node.js含む), CFML(ColdFusion Markup Language)
- その他、C#, Ruby, PHP, Rust, SQL, HTML, CSSなど、多くの言語に対応しています
- 対応言語は順次拡大予定です
- ファイルサイズ制限: 最大500MB（推奨: 100MB以下）
- 推奨ブラウザ: Google Chrome
活用シーン
Usagiは、以下のような場面で活用できます：
- レガシーシステムの理解 - ドキュメントが失われたシステムの仕様を可視化
- リプレイス準備 - 既存システムの設計情報を整理し、移行計画を策定
- 新メンバーのオンボーディング - 複雑なコードベースを素早く理解
- 品質保証 - テスト計画・仕様書を自動生成し、テスト漏れを防止
- ドキュメント整備 - 開発ドキュメントを効率的に作成・更新
ガイド構成
本ユーザーガイドは、以下の構成でUsagiの使い方を説明します：
はじめに
- はじめにガイド - 30分で最初のドキュメント生成を体験
ユーザーガイド
- ログイン - Usagiへのログイン方法
- ダッシュボード - プロジェクト管理とダッシュボードの使い方
- ソースコードのアップロード - ZIPファイルのアップロード方法
- ドキュメント生成 - AIによるドキュメント生成方法
- ドキュメントの閲覧・ダウンロード - 生成したドキュメントの確認とダウンロード
サポート
- よくある質問（FAQ） - Usagiに関するよくある質問と回答
- トラブルシューティング - 問題が発生した場合の対処方法
困ったときは
- よくある質問: FAQをご確認ください
- トラブルシューティング: トラブルシューティングガイドで解決方法を探せます
- サポート連絡先: 未定（準備中）