Poker Task Management MCP

# 📋 マニュアル文書 括弧統一ルール **対象**: poker_mcpマニュアル文書全体 **適用範囲**: docs/manualsフォルダ配下の全.mdファイル **策定日**: 2025年9月25日 **目的**: 技術文書としての統一性と可読性の向上 --- ## 🎯 基本ルール ### **ルール1: 技術仕様では半角括弧「()」** 技術的な仕様、コード、数式、単位、パラメータ、API仕様では**半角括弧「()」**を使用。 **適用対象**: - 単位表記: `(g/cm³)`, `(cm⁻¹)`, `(Bq)`, `(MeV)` - パラメータ仕様: `radius (半径)`, `center (x y z形式)` - コード記述: `poker_proposeBody()`, `if (condition)` - 数式: `I = I₀ × e^(-μt)`, `B(μt, E)` - APIレスポンス: `{"status": "success", "data": {...}}` - ファイル形式: `(YAML形式)`, `(.summary)` - エラーコード: `(-32075)`, `(-32600)` ### **ルール2: 一般説明では全角括弧「（）」** 日本語による説明文、注釈、補足説明では**全角括弧「（）」**を使用。 **適用対象**: - 説明補足: `問題の対処法（緊急時）` - 分類表示: `対象読者（全ユーザー）` - 注釈: `使用方法（Claude Desktop）` - 段階表示: `第1章（基礎編）` - 状態表示: `検索中（進行中）` --- ## 📖 具体的適用例 ### ✅ **正しい使用例** #### 技術仕様 - 半角括弧「()」: ```markdown - poker_proposeZone(body_name, material) - 密度設定: 2.3 (g/cm³) - 線減衰係数: μ (cm⁻¹) - エラーコード: (-32075) - 座標指定: center (x y z形式) ``` #### 一般説明 - 全角括弧「（）」: ```markdown - バージョン（1.2.0 MCP Edition） - 対象読者（放射線遮蔽研究者・実務者） - 問題分類（緊急度別） - 使用方法（Claude Desktopで実行） ``` ### ❌ **誤った使用例** #### 技術仕様で全角括弧（混在パターン）: ```markdown ❌ poker_proposeZone（body_name, material） ❌ 密度設定: 2.3 （g/cm³） ❌ エラーコード: （-32075） ``` #### 説明文で半角括弧（混在パターン）: ```markdown ❌ バージョン(1.2.0 MCP Edition) ❌ 対象読者(放射線遮蔽研究者・実務者) ❌ 問題分類(緊急度別) ``` --- ## 🔍 判定基準 ### **技術仕様判定チェックリスト** 以下のいずれかに該当する場合は**半角括弧「()」**: - [ ] API/メソッド名またはその引数 - [ ] プログラムコード（疑似コード含む） - [ ] 数値+単位の組み合わせ - [ ] 数式・計算式 - [ ] ファイル名・拡張子 - [ ] エラーコード・ステータスコード - [ ] 座標・ベクトル表記 ### **一般説明判定チェックリスト** 以下のいずれかに該当する場合は**全角括弧「（）」**: - [ ] 日本語での補足・注釈 - [ ] 対象読者・適用範囲の説明 - [ ] 分類・段階の表示 - [ ] 状態・属性の説明 - [ ] 時期・期間の表示 --- ## 🚀 適用手順 ### **段階1: 既存文書の分析** 1. 現在の括弧使用状況の全数調査 2. 技術仕様部分と説明文部分の分類 3. 修正箇所の特定とリスト化 ### **段階2: 一括修正実行** 1. 技術仕様部分: 全角括弧「（）」→ 半角括弧「()」 2. 説明文部分: 半角括弧「()」→ 全角括弧「（）」 3. 境界部分の個別判定と修正 ### **段階3: 品質確認** 1. 各ファイルでの統一性確認 2. 文脈に応じた適切性確認 3. 技術文書としての可読性確認 --- ## 📝 適用対象ファイル ``` docs/manuals/ ├── ADMIN_GUIDE.md ├── API_COMPLETE.md ├── ESSENTIAL_GUIDE.md ├── INTEGRATION_GUIDE.md ├── PHYSICS_REFERENCE.md ├── QUICK_REFERENCE.md ├── RESEARCH_WORKFLOWS.md ├── TROUBLESHOOTING.md └── README.md ``` --- ## ⚡ 今後の運用 ### **新規作成時** - 作成段階でこのルールを適用 - レビュー時に括弧使用の確認を実施 ### **既存更新時** - 修正箇所周辺の括弧統一も同時実施 - 部分修正時も全体統一性を保持 ### **品質保証** - 定期的な括弧使用状況の監査 - 統一ルール遵守状況の確認 --- **このルールにより、poker_mcpマニュアル文書群の技術文書としての統一性と専門性が向上し、研究者・技術者にとってより使いやすい文書体系を実現します。**