Docs Architect
コードから技術ドキュメントを生成
開発者はコードベースの進化に伴い、包括的なドキュメントを維持することに苦労しています。Docs Architect スキルはコードを自動的に分析し、アーキテクチャ、設計パターン、実装詳細を網羅した詳細な技術マニュアルを作成します。
تنزيل ZIP المهارة
رفع في Claude
اذهب إلى Settings → Capabilities → Skills → Upload skill
فعّل وابدأ الاستخدام
اختبرها
استخدام "Docs Architect". このコードベースの認証システムをドキュメント化してください
النتيجة المتوقعة:
ユーザー認証フロー、トークン管理、セッション処理、セキュリティの考慮事項、主要な実装詳細を示すコード例を網羅した包括的なセクション
استخدام "Docs Architect". このマイクロサービスアプリケーションのアーキテクチャ概要を作成してください
النتيجة المتوقعة:
エグゼクティブサマリー、サービス依存関係図、通信パターン、データストレージ戦略、デプロイメントトポロジ、各主要な意思決定の設計上の理由
استخدام "Docs Architect". 決済処理モジュールの API ドキュメントを作成してください
النتيجة المتوقعة:
エンドポイント定義、リクエスト/レスポンススキーマ、認証要件、エラーコード、レート制限、使用例を含む完全な API リファレンス
التدقيق الأمني
آمنPrompt-only documentation skill with no executable code. Static analysis found zero suspicious patterns and no risk factors. This is a pure prompt template skill that guides AI to generate documentation from analyzed codebases.
درجة الجودة
ماذا يمكنك بناءه
新規開発者のオンボーディング
新しいチームメンバーがシステムアーキテクチャ、依存関係、コーディング規約を理解するための包括的なドキュメントを生成
レガシーコードのドキュメント化
ドキュメントのない既存システムを文書化し、知識を保存して将来のメンテナンスを支援
アーキテクチャ意思決定記録
設計上の選択、トレードオフ、システムアーキテクチャの進化を説明する詳細な ADR を作成
جرّب هذه الموجهات
以下のコードファイルを分析してドキュメントを作成してください。各主要セクションの機能、使用されているデータ構造、重要なパターンを説明してください:
このコードベースの包括的なアーキテクチャ概要を提供してください。エグゼクティブサマリー、主要コンポーネント、データフロー、重要な設計上の意思決定を含めてください。
このコードベースの完全な API リファレンスを生成してください。すべてのエンドポイント、リクエスト/レスポンス形式、認証要件、エラーコードを文書化してください。
以下の内容を網羅した包括的な技術マニュアルを作成してください：アーキテクチャ概要、設計上の意思決定、コアコンポーネント、データモデル、統合ポイント、デプロイ、セキュリティ、トラブルシューティング。全体にコード例を含めてください。
أفضل الممارسات
- 読者にコンテキストを提供するために、実装詳細に入る前に高レベルのアーキテクチャから始める
- 実際のコードベースからコード例を含めて、現実のコンテキストで概念を説明する
- 現在の状態だけでなく設計上の意思決定の背景にある理由も文書化し、読者が進化を理解できるようにする
تجنب
- コードベースの構造と依存関係をまず理解せずにドキュメントを生成すること
- コンテキスト、説明、物語の流れを追加せずにコードコメントをコピーペーストすること
- 実施された理由やトレードオフを説明せずに実装詳細のみに焦点を当てること