UNPKG

@memory-bank/mcp

Version:

Memory-enabled Co-Pilot (MCP) server for managing project documentation and context

124 lines (118 loc) 20.3 kB
{ "language": "ja", "translations": { "template.title.rules": "ブランチメモリバンク運用ガイドライン", "template.description.rules": "ブランチメモリバンクのコアファイルの目的と推奨される記録内容", "template.section.global_memory_bank": "グローバルメモリバンク", "template.content.global_memory_bank": "グローバルメモリバンクは、プロジェクト全体で共有される知識を保存するための中央リポジトリです。すべてのブランチから参照可能で、プロジェクトの基本情報、アーキテクチャ、設計決定などの重要な情報を含みます。", "template.section.purpose_of_global_memory_bank": "グローバルメモリバンクの目的", "template.content.purpose_of_global_memory_bank": "グローバルメモリバンクの主な目的は、プロジェクトの知識を一元管理し、チームメンバー間で共有することです。これにより、新しいメンバーのオンボーディングが容易になり、プロジェクトの一貫性が保たれます。", "template.section.global_memory_bank_structure": "グローバルメモリバンクの構造", "template.content.global_memory_bank_structure": "グローバルメモリバンクは以下のディレクトリ構造に基づいて整理されています:\n\n- core/ - 基本情報\n- 01-project/ - プロジェクト関連の詳細情報\n- 02-architecture/ - アーキテクチャ関連の詳細情報\n- 03-implementation/ - 実装関連の詳細情報\n- 04-guides/ - 詳細なガイドとマニュアル\n- 05-testing/ - テスト関連の情報\n- 06-releases/ - リリース情報\n- 07-infrastructure/ - インフラ関連の情報\n- 08-i18n/ - 国際化関連の情報\n- 09-refactoring/ - リファクタリング関連の情報\n- meta/ - メタデータと管理情報\n- tags/ - タグシステム情報", "template.section.tag_system": "タグシステム", "template.content.tag_system": "タグは、ドキュメントを分類し検索するための重要な手段です。タグを効果的に使用するために以下のルールに従ってください:\n\n- タグは小文字のアルファベット、数字、ハイフンのみを使用(大文字、スペース、アンダースコア、ドットは使用不可)\n- 例: `architecture`、`design-patterns`、`v1-beta`(OK)\n- 例: `Design`、`user_guide`、`v2.0`(NG)", "template.section.json_architecture": "JSON構造", "template.content.json_architecture": "メモリバンクのドキュメントはJSON形式で保存され、以下の構造を持ちます:\n\n```json\n{\n \"schema\": \"memory_document_v2\",\n \"metadata\": {\n \"id\": \"一意の識別子\",\n \"title\": \"ドキュメントのタイトル\",\n \"documentType\": \"ドキュメントタイプ\",\n \"path\": \"相対パス\",\n \"tags\": [\"関連タグ\"],\n \"lastModified\": \"最終更新日時\",\n \"createdAt\": \"作成日時\",\n \"version\": 1\n },\n \"content\": {\n // ドキュメントの内容\n }\n}\n```", "template.section.branch_memory_bank": "ブランチメモリバンク", "template.content.branch_memory_bank": "ブランチメモリバンクは、特定のブランチ(機能実装や修正作業)に関連する情報を保存するためのメモリバンクです。各ブランチには独自のメモリバンクがあり、そのブランチ固有のコンテキスト情報を保持します。", "template.section.memory_bank_structure": "メモリバンクの構造", "template.content.memory_bank_structure": "メモリバンクは、ドキュメントの集合体です。各ドキュメントはJSONファイルとして保存され、メタデータとコンテンツを持ちます。メタデータには、ドキュメントのID、タイトル、タイプ、パス、タグ、更新日時などの情報が含まれます。", "template.section.required_files": "必須ファイル", "template.content.required_files": "各ブランチメモリバンクには、以下の4つのコアファイルが必要です:\n\n1. **branchContext.json** - ブランチの目的、ユーザーストーリー、要件\n2. **activeContext.json** - 現在の作業内容、直近の変更、アクティブな決定事項\n3. **systemPatterns.json** - 技術的決定事項、関連するファイル構造\n4. **progress.json** - 現在の進捗状況、未実装の機能、既知の問題", "template.section.additional_context": "追加コンテキスト", "template.content.additional_context": "メモリバンクには、必要に応じて追加のドキュメントを保存することができます。これらのドキュメントは、特定の機能や実装に関する詳細情報、設計ドキュメント、テスト計画などを含むことができます。", "template.section.core_workflow": "基本的なワークフロー", "template.content.core_workflow": "メモリバンクを使用する基本的なワークフローは以下の通りです:\n\n1. ブランチを作成する際に、ブランチメモリバンクを初期化する\n2. 作業を進める中で、関連情報をブランチメモリバンクに記録する\n3. 重要な決定事項や設計パターンを記録する\n4. 進捗状況を更新する\n5. ブランチをマージする際に、重要な情報をグローバルメモリバンクに移行する", "template.section.task_progress_workflow": "タスク進捗ワークフロー", "template.content.task_progress_workflow": "タスクの進捗を記録するワークフローは以下の通りです:\n\n1. タスクを開始する際に、activeContext.jsonに現在の作業内容を記録する\n2. 実装が完了した機能をprogress.jsonに記録する\n3. 未実装の機能や残作業をprogress.jsonに記録する\n4. 既知の問題や課題をprogress.jsonに記録する\n5. タスクが完了したら、activeContext.jsonを更新する", "template.section.document_updates": "ドキュメントの更新", "template.content.document_updates": "ドキュメントを更新する際は、以下のルールに従ってください:\n\n1. メタデータの`lastModified`フィールドを現在の日時に更新する\n2. メタデータの`version`フィールドをインクリメントする\n3. 変更内容を適切に記録する\n4. 必要に応じてタグを更新する", "template.section.migration_strategy": "マイグレーション戦略", "template.content.migration_strategy": "ブランチがマージされる際には、重要な情報をグローバルメモリバンクに移行することを検討してください。特に、再利用可能なパターンや重要な設計決定事項は、グローバルメモリバンクに保存することで、他のチームメンバーも参照できるようになります。", "template.section.file_editing_rules": "ファイル編集ルール", "template.content.file_editing_rules": "メモリバンクのファイルを編集する際は、以下のルールに従ってください:\n\n1. 直接ファイルを編集するのではなく、CLIコマンドを使用する\n2. JSONの構文が正しいことを確認する\n3. 必須フィールドを削除しない\n4. スキーマバージョンを変更しない", "template.section.finally": "最後に", "template.content.finally": "メモリバンクは、プロジェクトの知識を管理するための強力なツールです。適切に使用することで、チームの生産性と協力を向上させることができます。", "template.section.footer": "(フッター)", "template.content.footer": "---\n\n_このドキュメントはメモリーバンクの基本的なルールと構造を説明するものです_", "template.title.active_context": "アクティブコンテキストテンプレート", "template.description.active_context": "現在の作業状況や最近の変更点を記録するためのテンプレート", "template.section.current_work": "現在の作業内容", "template.content.current_work": "<!-- 現在進めている具体的な作業内容を記述 -->\n{{CURRENT_WORK}}", "template.section.recent_changes": "直近の変更点", "template.content.recent_changes": "<!-- 最近実装した変更や追加機能について記述 -->\n{{RECENT_CHANGES}}", "template.section.active_decisions": "今アクティブな決定事項", "template.content.active_decisions": "<!-- 最近行われた重要な技術的決定事項を記述 -->\n{{ACTIVE_DECISIONS}}", "template.section.considerations": "検討事項", "template.content.considerations": "<!-- 現在検討中の課題や疑問点を記述 -->\n{{CONSIDERATIONS}}", "template.section.next_steps": "次のステップ", "template.content.next_steps": "<!-- 次に着手予定のタスクや優先順位を記述 -->\n{{NEXT_STEPS}}", "template.placeholder.current_work": "現在の作業内容のプレースホルダー", "template.placeholder.recent_changes": "直近の変更点のプレースホルダー", "template.placeholder.active_decisions": "アクティブな決定事項のプレースホルダー", "template.placeholder.considerations": "検討事項のプレースホルダー", "template.placeholder.next_steps": "次のステップのプレースホルダー", "template.title.branch_context": "ブランチコンテキストテンプレート", "template.description.branch_context": "ブランチの目的や背景情報を記録するためのテンプレート", "template.section.purpose": "このブランチの目的", "template.content.purpose": "<!-- ブランチの目的を簡潔に記述してください -->", "template.section.background": "背景", "template.content.background": "<!-- このブランチが作成された背景や理由を説明してください -->", "template.section.user_stories": "ユーザーストーリー", "template.content.user_stories": "### 解決したい課題\n\n<!-- 解決したい問題を記述 -->\n{{PROBLEM}}\n\n### 必要な機能\n\n<!-- 必要な機能を記述 -->\n{{FEATURES}}\n\n### 期待される動作\n\n<!-- 期待される動作を記述 -->\n{{BEHAVIOR}}", "template.section.related_issues": "関連する課題", "template.content.related_issues": "<!-- 関連するGitHub Issue、JIRA チケットなどを記述 -->\n{{ISSUES}}", "template.section.technical_considerations": "技術的検討事項", "template.content.technical_considerations": "<!-- 実装にあたっての技術的検討事項を記述 -->\n{{TECH_CONSIDERATIONS}}", "template.placeholder.problem": "解決したい課題のプレースホルダー", "template.placeholder.features": "必要な機能のプレースホルダー", "template.placeholder.behavior": "期待される動作のプレースホルダー", "template.placeholder.issues": "関連する課題のプレースホルダー", "template.placeholder.tech_considerations": "技術的検討事項のプレースホルダー", "template.title.progress": "進捗状況テンプレート", "template.description.progress": "機能の実装状況や残作業を記録するためのテンプレート", "template.section.working_features": "現時点で動作している部分", "template.content.working_features": "<!-- 実装済みで正常に動作している機能を記述 -->\n{{WORKING_FEATURES}}", "template.section.unimplemented_features": "未実装の機能や残作業", "template.content.unimplemented_features": "<!-- まだ実装していない機能や残りのタスクを記述 -->\n{{UNIMPLEMENTED_FEATURES}}", "template.section.current_status": "現在の状態", "template.content.current_status": "<!-- 開発の現状や全体的な進捗度を記述 -->\n{{CURRENT_STATUS}}", "template.section.known_issues": "既知の問題", "template.content.known_issues": "<!-- 既知のバグや問題点を記述 -->\n{{KNOWN_ISSUES}}", "template.section.completion_criteria": "完了基準", "template.content.completion_criteria": "<!-- このブランチが完了したと見なすための基準を記述 -->\n{{COMPLETION_CRITERIA}}", "template.placeholder.working_features": "動作している機能のプレースホルダー", "template.placeholder.unimplemented_features": "未実装の機能のプレースホルダー", "template.placeholder.current_status": "現在の状態のプレースホルダー", "template.placeholder.known_issues": "既知の問題のプレースホルダー", "template.placeholder.completion_criteria": "完了基準のプレースホルダー", "template.title.system_patterns": "システムパターンテンプレート", "template.description.system_patterns": "技術的決定事項やアーキテクチャパターンを記録するためのテンプレート", "template.section.technical_decisions": "技術的決定事項", "template.content.technical_decisions": "<!-- 主要な技術的判断を記述(ADR形式が望ましい) -->\n\n### テスト方針\n\n#### コンテキスト\n\n<!--意思決定の背景-->\n\n#### 決定事項\n\n<!--どのような決定をしたか-->\n\n#### 影響\n\n<!--その決定の影響-->\n\n### フォルダ構造\n\n#### コンテキスト\n\n<!--意思決定の背景-->\n\n#### 決定事項\n\n<!--どのような決定をしたか-->\n\n#### 影響\n\n<!--その決定の影響-->", "template.section.file_structure": "関連するファイルやディレクトリ構造", "template.content.file_structure": "<!-- コードの主要なファイル構造やディレクトリ構造を記述 -->\n```\n# ディレクトリ構造例\nsrc/\n ├── domain/\n ├── application/\n ├── infrastructure/\n └── interface/\n```", "template.section.design_patterns": "デザインパターン", "template.content.design_patterns": "<!-- 使用しているデザインパターンとその適用方法を記述 -->\n{{DESIGN_PATTERNS}}", "template.section.architecture": "アーキテクチャ", "template.content.architecture": "<!-- アーキテクチャの概要や特徴的な部分を記述 -->\n{{ARCHITECTURE}}", "template.placeholder.design_patterns": "デザインパターンのプレースホルダー", "template.placeholder.architecture": "アーキテクチャのプレースホルダー", "template.section.branchMemoryGuidelines": "はじめに", "template.content.branchMemoryGuidelines": "このガイドラインは、ブランチメモリバンクの効果的な運用方法と、各コアファイルの目的および推奨される記録内容を定義します。ブランチメモリバンクは、特定の機能開発や修正作業に関するコンテキスト情報を集約し、チーム内の情報共有と作業の引き継ぎを円滑にすることを目的とします。", "template.section.branchContextJson": "1. branchContext.json", "template.content.branchContextJson": "**目的:** ブランチの基本的な情報と目的を定義します。\n**推奨される記録内容:**\n- `purpose`: このブランチが解決しようとしている課題や目的を具体的に記述します。\n- `userStories`: 関連するユーザーストーリーやタスクをリストアップし、進捗(completed)や優先度(priority)を管理します。\n- `additionalNotes`: その他、ブランチ全体に関する補足情報があれば記述します。\n**更新タイミング:** ブランチ作成時、またはブランチの目的やスコープに変更があった場合。", "template.section.activeContextJson": "2. activeContext.json", "template.content.activeContextJson": "**目的:** ブランチにおける現在の作業状況、直近の変更履歴、アクティブな決定事項、検討中の課題、次のステップを記録します。\n**推奨される記録内容:**\n- `currentWork`: 現在取り組んでいる具体的なタスクや作業内容を記述します。\n- `recentChanges`: 直近で行った重要な変更(コード修正、ドキュメント更新、設定変更など)を日付と共に記録します。\n- `activeDecisions`: 作業中に決定した事項(技術選定、仕様変更など)とその理由(任意)を記録します。\n- `considerations`: 現在検討中の課題や選択肢、そのステータス(open, resolved, deferred)を記録します。\n- `nextSteps`: 次に取り組むべきタスクやアクションアイテムを優先度と共にリストアップします。\n**更新タイミング:** 日々の作業終了時、重要な変更や決定があった時、作業を引き継ぐ前など、頻繁に更新することが推奨されます。", "template.section.progressJson": "3. progress.json", "template.content.progressJson": "**目的:** ブランチにおける機能実装の進捗状況、未実装のタスク、既知の問題点を管理します。\n**推奨される記録内容:**\n- `workingFeatures`: 実装が完了し、動作している機能やコンポーネントをリストアップし、実装日時を記録します。\n- `pendingImplementation`: これから実装する予定の機能やタスクを優先度と共にリストアップします。完了予定日(estimatedCompletion)も任意で記録できます。\n- `status`: ブランチ全体の開発ステータス(planning, in-development, testing, completedなど)を記述します。\n- `completionPercentage`: ブランチ全体の完了率(目安)を記録します。\n- `knownIssues`: 現在認識されているバグや問題点を重要度(severity)と共にリストアップします。回避策(workaround)も任意で記録できます。\n**更新タイミング:** 機能の実装が完了した時、新しい問題を発見した時、ブランチのマージ前など、進捗に変化があった場合に更新します。", "template.section.systemPatternsJson": "4. systemPatterns.json", "template.content.systemPatternsJson": "**目的:** ブランチ内で行われた重要な技術的決定や、採用された実装パターンを記録します。\n**推奨される記録内容:**\n- `technicalDecisions`: アーキテクチャに関する決定、ライブラリ選定、API設計など、将来の参照価値がある技術的決定事項を記録します。決定の背景(context)、具体的な決定内容(decision)、その影響(consequences)、ステータス(status)、代替案(alternatives)なども含めるとより有用です。\n- `implementationPatterns`: ブランチ内で繰り返し使用される特定の実装パターンやコードスニペットがあれば記録します(任意)。\n**更新タイミング:** 重要な技術的決定が行われた際や、特筆すべき実装パターンが確立された場合に記録します。", "template.section.bestPractices": "運用のベストプラクティス", "template.content.bestPractices": "- **こまめな更新:** 各コアファイルは、情報が古くならないように、関連する変更があった際にこまめに更新しましょう。\n- **簡潔かつ具体的に:** 誰が読んでも理解できるように、内容は簡潔かつ具体的に記述しましょう。\n- **チームでの共有:** ブランチメモリバンクの情報はチームメンバーと共有し、認識合わせに活用しましょう。\n- **タグの活用:** 各ドキュメントには適切なタグを付与し、将来的な情報検索に備えましょう(例: `core`, `decision`, `refactoring-plan` など)。" }, "metadata": { "version": "1.0.0", "updatedAt": "2025-04-01T01:37:00.000Z" } }