jupytermind 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (193) hide show
  1. package/.github/skills/ai-chemistry-scientist/SKILL.md +97 -0
  2. package/.github/skills/ai-chemistry-scientist/manifest.json +156 -0
  3. package/.github/skills/ai-data-scientist/SKILL.md +330 -0
  4. package/.github/skills/ai-genomics-scientist/SKILL.md +98 -0
  5. package/.github/skills/ai-genomics-scientist/manifest.json +93 -0
  6. package/.github/skills/ai-materials-scientist/SKILL.md +51 -0
  7. package/.github/skills/ai-materials-scientist/manifest.json +58 -0
  8. package/.github/skills/ai-scientist/SKILL.md +69 -0
  9. package/.github/skills/ai-scientist/manifest.json +61 -0
  10. package/.github/skills/ai-structural-biology-scientist/SKILL.md +67 -0
  11. package/.github/skills/ai-structural-biology-scientist/manifest.json +72 -0
  12. package/.github/skills/japanese-prose/NOTICE.md +17 -0
  13. package/.github/skills/japanese-prose/SKILL.md +111 -0
  14. package/.github/skills/japanese-prose/references/review-workflow.md +50 -0
  15. package/.github/skills/japanese-prose/references/scoring.md +24 -0
  16. package/.github/skills/japanese-prose/references/writing-guidelines.md +60 -0
  17. package/.github/skills/japanese-prose/scripts/core.py +192 -0
  18. package/.github/skills/japanese-prose/scripts/fixtures/natural.md +5 -0
  19. package/.github/skills/japanese-prose/scripts/fixtures/unnatural.md +5 -0
  20. package/.github/skills/japanese-prose/scripts/lint.py +378 -0
  21. package/.github/skills/japanese-prose/scripts/outline.py +68 -0
  22. package/.github/skills/japanese-prose/scripts/terms.py +112 -0
  23. package/.github/skills/japanese-prose/scripts/test_engine.py +117 -0
  24. package/.github/skills/presentation-planner/SKILL.md +257 -0
  25. package/.github/skills/presentation-planner/assets/design-templates/data-report.yaml +97 -0
  26. package/.github/skills/presentation-planner/assets/design-templates/executive-proposal.yaml +92 -0
  27. package/.github/skills/presentation-planner/assets/design-templates/technical-briefing.yaml +96 -0
  28. package/.github/skills/presentation-planner/assets/scenario-templates/data-report.md +47 -0
  29. package/.github/skills/presentation-planner/assets/scenario-templates/executive-decision.md +43 -0
  30. package/.github/skills/presentation-planner/assets/scenario-templates/technical-briefing.md +45 -0
  31. package/.github/skills/presentation-planner/references/customizing-design-templates.md +160 -0
  32. package/.github/skills/presentation-planner/references/design-spec-schema.md +72 -0
  33. package/.github/skills/presentation-planner/references/handoff-contract.md +49 -0
  34. package/.github/skills/presentation-planner/references/responsibility-boundary.md +32 -0
  35. package/.github/skills/presentation-planner/references/scenario-templates.md +55 -0
  36. package/.github/skills/tech-writer/SKILL.md +434 -0
  37. package/.github/skills/tech-writer/assets/templates/blueprint.md +187 -0
  38. package/.github/skills/tech-writer/assets/templates/design-doc.md +29 -0
  39. package/.github/skills/tech-writer/assets/templates/migration-plan.md +173 -0
  40. package/.github/skills/tech-writer/assets/templates/operations-runbook.md +202 -0
  41. package/.github/skills/tech-writer/assets/templates/pr-description.md +23 -0
  42. package/.github/skills/tech-writer/assets/templates/qiita.md +44 -0
  43. package/.github/skills/tech-writer/assets/templates/readme.md +38 -0
  44. package/.github/skills/tech-writer/assets/templates/requirements-definition.md +170 -0
  45. package/.github/skills/tech-writer/assets/templates/rfi.md +113 -0
  46. package/.github/skills/tech-writer/assets/templates/rfp.md +180 -0
  47. package/.github/skills/tech-writer/assets/templates/security-design.md +167 -0
  48. package/.github/skills/tech-writer/assets/templates/system-design.md +220 -0
  49. package/.github/skills/tech-writer/assets/templates/technical-proposal.md +112 -0
  50. package/.github/skills/tech-writer/assets/templates/test-plan.md +153 -0
  51. package/.github/skills/tech-writer/assets/templates/user-manual.md +22 -0
  52. package/.github/skills/tech-writer/assets/templates/white-paper.md +192 -0
  53. package/.github/skills/tech-writer/references/doctypes/api-docs.md +33 -0
  54. package/.github/skills/tech-writer/references/doctypes/blueprint.md +81 -0
  55. package/.github/skills/tech-writer/references/doctypes/code-comments.md +39 -0
  56. package/.github/skills/tech-writer/references/doctypes/design-doc.md +42 -0
  57. package/.github/skills/tech-writer/references/doctypes/migration-plan.md +63 -0
  58. package/.github/skills/tech-writer/references/doctypes/operations-runbook.md +63 -0
  59. package/.github/skills/tech-writer/references/doctypes/pr-commit.md +82 -0
  60. package/.github/skills/tech-writer/references/doctypes/qiita.md +75 -0
  61. package/.github/skills/tech-writer/references/doctypes/readme.md +43 -0
  62. package/.github/skills/tech-writer/references/doctypes/release-notes.md +30 -0
  63. package/.github/skills/tech-writer/references/doctypes/requirements-definition.md +61 -0
  64. package/.github/skills/tech-writer/references/doctypes/rfi.md +43 -0
  65. package/.github/skills/tech-writer/references/doctypes/rfp.md +46 -0
  66. package/.github/skills/tech-writer/references/doctypes/security-design.md +71 -0
  67. package/.github/skills/tech-writer/references/doctypes/system-design.md +74 -0
  68. package/.github/skills/tech-writer/references/doctypes/technical-proposal.md +49 -0
  69. package/.github/skills/tech-writer/references/doctypes/test-plan.md +67 -0
  70. package/.github/skills/tech-writer/references/doctypes/user-manual.md +58 -0
  71. package/.github/skills/tech-writer/references/doctypes/white-paper.md +84 -0
  72. package/.github/skills/tech-writer/references/doctypes/zenn.md +66 -0
  73. package/.github/skills/tech-writer/references/japanese-prose-optimization.md +110 -0
  74. package/.github/skills/tech-writer/references/style-constitution.md +104 -0
  75. package/.github/skills/tech-writer/scripts/lint.py +412 -0
  76. package/LICENSE +21 -0
  77. package/README.md +92 -0
  78. package/bin/ai-data-scientist.js +123 -0
  79. package/package.json +41 -0
  80. package/pyproject.toml +45 -0
  81. package/src/ai_chemistry_scientist/__init__.py +0 -0
  82. package/src/ai_chemistry_scientist/admet_prediction.py +71 -0
  83. package/src/ai_chemistry_scientist/bioactivity_classification.py +73 -0
  84. package/src/ai_chemistry_scientist/data/sample_molecules.csv +21 -0
  85. package/src/ai_chemistry_scientist/dispatch.py +369 -0
  86. package/src/ai_chemistry_scientist/docking_score.py +97 -0
  87. package/src/ai_chemistry_scientist/drug_likeness_rules.py +84 -0
  88. package/src/ai_chemistry_scientist/evidence.py +41 -0
  89. package/src/ai_chemistry_scientist/molecular_descriptors.py +97 -0
  90. package/src/ai_chemistry_scientist/molecular_formula_mass.py +40 -0
  91. package/src/ai_chemistry_scientist/molecular_similarity.py +78 -0
  92. package/src/ai_chemistry_scientist/qsar_modeling.py +105 -0
  93. package/src/ai_chemistry_scientist/salt_standardization.py +81 -0
  94. package/src/ai_chemistry_scientist/structural_alerts.py +76 -0
  95. package/src/ai_chemistry_scientist/structure_format_conversion.py +84 -0
  96. package/src/ai_chemistry_scientist/validation.py +70 -0
  97. package/src/ai_data_scientist/__init__.py +0 -0
  98. package/src/ai_data_scientist/analysis_assumptions.py +121 -0
  99. package/src/ai_data_scientist/anomaly_detection.py +39 -0
  100. package/src/ai_data_scientist/automl.py +109 -0
  101. package/src/ai_data_scientist/cleaning.py +56 -0
  102. package/src/ai_data_scientist/cli.py +90 -0
  103. package/src/ai_data_scientist/clustering.py +54 -0
  104. package/src/ai_data_scientist/dashboard.py +33 -0
  105. package/src/ai_data_scientist/data_definition.py +100 -0
  106. package/src/ai_data_scientist/data_quality.py +164 -0
  107. package/src/ai_data_scientist/dataset_validation.py +135 -0
  108. package/src/ai_data_scientist/dependency_pins.py +60 -0
  109. package/src/ai_data_scientist/eda.py +82 -0
  110. package/src/ai_data_scientist/experiment_evaluation.py +635 -0
  111. package/src/ai_data_scientist/explainability.py +340 -0
  112. package/src/ai_data_scientist/feature_engineering.py +163 -0
  113. package/src/ai_data_scientist/gate_config.py +32 -0
  114. package/src/ai_data_scientist/ingestion.py +127 -0
  115. package/src/ai_data_scientist/insight_engine.py +180 -0
  116. package/src/ai_data_scientist/japanese_nlp.py +43 -0
  117. package/src/ai_data_scientist/jupyter_launcher.py +137 -0
  118. package/src/ai_data_scientist/jupyter_mcp_client.py +94 -0
  119. package/src/ai_data_scientist/language_router.py +28 -0
  120. package/src/ai_data_scientist/lifecycle.py +221 -0
  121. package/src/ai_data_scientist/mcp_gateway.py +113 -0
  122. package/src/ai_data_scientist/mcp_runtime.py +194 -0
  123. package/src/ai_data_scientist/mcp_transport.py +53 -0
  124. package/src/ai_data_scientist/ml_modeling.py +451 -0
  125. package/src/ai_data_scientist/model_tuning.py +104 -0
  126. package/src/ai_data_scientist/notebook_audit.py +574 -0
  127. package/src/ai_data_scientist/project_manager.py +243 -0
  128. package/src/ai_data_scientist/report_export.py +73 -0
  129. package/src/ai_data_scientist/sensitivity.py +445 -0
  130. package/src/ai_data_scientist/signal_analysis.py +201 -0
  131. package/src/ai_data_scientist/skill_packaging.py +40 -0
  132. package/src/ai_data_scientist/stats_analysis.py +88 -0
  133. package/src/ai_data_scientist/text_nlp.py +44 -0
  134. package/src/ai_data_scientist/timeseries.py +68 -0
  135. package/src/ai_data_scientist/visualization.py +708 -0
  136. package/src/ai_genomics_scientist/__init__.py +1 -0
  137. package/src/ai_genomics_scientist/differential_expression.py +147 -0
  138. package/src/ai_genomics_scientist/dispatch.py +267 -0
  139. package/src/ai_genomics_scientist/evidence.py +45 -0
  140. package/src/ai_genomics_scientist/gene_set_enrichment.py +76 -0
  141. package/src/ai_genomics_scientist/sequence_alignment.py +97 -0
  142. package/src/ai_genomics_scientist/sequence_features.py +111 -0
  143. package/src/ai_genomics_scientist/splice_site_scoring.py +66 -0
  144. package/src/ai_genomics_scientist/validation.py +83 -0
  145. package/src/ai_genomics_scientist/variant_effect.py +147 -0
  146. package/src/ai_genomics_scientist/variant_pathogenicity.py +125 -0
  147. package/src/ai_materials_scientist/__init__.py +0 -0
  148. package/src/ai_materials_scientist/calphad.py +117 -0
  149. package/src/ai_materials_scientist/classical_monte_carlo.py +165 -0
  150. package/src/ai_materials_scientist/crystal_plasticity.py +184 -0
  151. package/src/ai_materials_scientist/dispatch.py +100 -0
  152. package/src/ai_materials_scientist/evidence.py +84 -0
  153. package/src/ai_materials_scientist/fem.py +279 -0
  154. package/src/ai_materials_scientist/kinetic_monte_carlo.py +145 -0
  155. package/src/ai_materials_scientist/molecular_dynamics.py +240 -0
  156. package/src/ai_materials_scientist/phase_field.py +167 -0
  157. package/src/ai_materials_scientist/validation.py +70 -0
  158. package/src/ai_scientist/__init__.py +1 -0
  159. package/src/ai_scientist/completion_gate.py +15 -0
  160. package/src/ai_scientist/data_analysis.py +46 -0
  161. package/src/ai_scientist/evidence_registry.py +99 -0
  162. package/src/ai_scientist/experimental_design.py +20 -0
  163. package/src/ai_scientist/language.py +14 -0
  164. package/src/ai_scientist/latex_renderer.py +41 -0
  165. package/src/ai_scientist/literature_review.py +37 -0
  166. package/src/ai_scientist/manifest.py +87 -0
  167. package/src/ai_scientist/manuscript.py +94 -0
  168. package/src/ai_scientist/mcp_config.py +76 -0
  169. package/src/ai_scientist/mcp_external.py +42 -0
  170. package/src/ai_scientist/mcp_failures.py +23 -0
  171. package/src/ai_scientist/mcp_gateway.py +38 -0
  172. package/src/ai_scientist/mcp_managed.py +180 -0
  173. package/src/ai_scientist/npm_packaging.py +49 -0
  174. package/src/ai_scientist/orchestrator.py +133 -0
  175. package/src/ai_scientist/peer_review.py +60 -0
  176. package/src/ai_scientist/phase_gate.py +74 -0
  177. package/src/ai_scientist/phase_state.py +230 -0
  178. package/src/ai_scientist/presentation.py +56 -0
  179. package/src/ai_scientist/project_config.py +31 -0
  180. package/src/ai_scientist/project_handle.py +74 -0
  181. package/src/ai_scientist/reproducibility.py +20 -0
  182. package/src/ai_scientist/research_planning.py +20 -0
  183. package/src/ai_scientist/skill_invocation.py +21 -0
  184. package/src/ai_scientist/tdd_gate.py +99 -0
  185. package/src/ai_structural_biology_scientist/__init__.py +0 -0
  186. package/src/ai_structural_biology_scientist/contact_map.py +87 -0
  187. package/src/ai_structural_biology_scientist/dispatch.py +269 -0
  188. package/src/ai_structural_biology_scientist/evidence.py +43 -0
  189. package/src/ai_structural_biology_scientist/hydrophobicity.py +101 -0
  190. package/src/ai_structural_biology_scientist/protein_docking_score.py +104 -0
  191. package/src/ai_structural_biology_scientist/secondary_structure.py +95 -0
  192. package/src/ai_structural_biology_scientist/structural_similarity.py +74 -0
  193. package/src/ai_structural_biology_scientist/validation.py +100 -0
@@ -0,0 +1,173 @@
1
+ # <システム・データ名> 移行計画書
2
+
3
+ <何をどこからどこへ、どの停止許容時間と品質基準で安全に移行するかを3文以内で要約する。>
4
+
5
+ - 文書版: <例: 1.0>
6
+ - 作成日: <YYYY-MM-DD>
7
+ - 最終更新日: <YYYY-MM-DD>
8
+ - 移行責任者: <氏名・チーム>
9
+ - Go / No-Go判断者: <氏名・会議体>
10
+ - ステータス: Draft / In Review / Approved
11
+ - 本番移行予定: <YYYY-MM-DD HH:mm–HH:mm TZ>
12
+ - 関連要件・設計: <文書名・版・URL>
13
+
14
+ ## この移行計画で合意する事項
15
+
16
+ - 移行対象: <データ、利用者、機能、外部接続>
17
+ - 移行方式: <一括、段階、並行稼働など>
18
+ - 許容停止時間と品質基準: <値>
19
+ - 承認を求める事項: <日程、体制、判定、ロールバック>
20
+
21
+ ## 現行と移行後の状態
22
+
23
+ | 項目 | 現行 | 移行後 | 主な変更 | 利用者への影響 |
24
+ |---|---|---|---|---|
25
+ | システム | <現行> | <移行先> | <変更> | <影響> |
26
+ | データ | <形式・量> | <形式・量> | <変換> | <影響> |
27
+ | 業務 | <手順> | <手順> | <変更> | <教育・周知> |
28
+
29
+ ## 対象範囲と対象外
30
+
31
+ ### 対象範囲
32
+
33
+ - <移行するデータ・設定・利用者・接続先>
34
+
35
+ ### 対象外
36
+
37
+ - <廃止しないもの・後続フェーズへ送るもの>
38
+
39
+ ## 前提条件と制約
40
+
41
+ | ID | 条件・制約 | 確認方法 | 期限 | 所有者 |
42
+ |---|---|---|---|---|
43
+ | MIG-CON-001 | <停止時間・契約・技術制約> | <確認> | <期限> | <担当> |
44
+
45
+ ## 移行対象の棚卸し
46
+
47
+ | 対象ID | 対象 | 移行元 | 移行先 | 件数・容量 | 所有者 | 依存関係 | 移行要否 |
48
+ |---|---|---|---|---:|---|---|---|
49
+ | MIG-001 | <データ・設定> | <場所> | <場所> | <値> | <担当> | <依存先> | Yes / No |
50
+
51
+ ## データマッピングと変換
52
+
53
+ | 移行元項目 | 移行先項目 | 変換ルール | 必須・既定値 | 検証ルール | エラー時の扱い |
54
+ |---|---|---|---|---|---|
55
+ | <項目> | <項目> | <変換> | <条件> | <型・範囲・参照整合性> | <除外・補正・中止> |
56
+
57
+ ## 移行方式と移行単位
58
+
59
+ - 方式: 一括 / 段階 / 並行稼働 / Blue-Green / <その他>
60
+ - 選定理由: <停止時間、整合性、ロールバックとの関係>
61
+ - 差分同期: <CDC、二重書き、再実行など>
62
+ - 冪等性: <再実行しても重複・欠損しない仕組み>
63
+
64
+ | Wave | 対象 | 実施日時 | 完了条件 | 次Waveへの判定 |
65
+ |---|---|---|---|---|
66
+ | 1 | <対象> | <日時> | <条件> | <条件> |
67
+
68
+ ## 体制と役割
69
+
70
+ | 役割 | 担当 | 責任 | 当日の連絡方法 | 代行者 |
71
+ |---|---|---|---|---|
72
+ | 移行指揮 | <担当> | Go / No-Go、進行 | <方法> | <担当> |
73
+ | データ移行 | <担当> | 抽出・変換・投入 | <方法> | <担当> |
74
+ | 業務確認 | <担当> | 業務受入 | <方法> | <担当> |
75
+ | 運用・監視 | <担当> | 監視・障害対応 | <方法> | <担当> |
76
+
77
+ ## リハーサル計画
78
+
79
+ | 回 | 目的 | 対象・データ量 | 実施日 | 目標時間 | 合格条件 | 改善事項 |
80
+ |---|---|---|---|---:|---|---|
81
+ | 1 | <手順・性能・復旧の検証> | <範囲> | <日付> | <時間> | <条件> | <記録> |
82
+
83
+ ## 移行開始条件
84
+
85
+ - <リハーサルが合格している>
86
+ - <対象版が承認され、変更凍結されている>
87
+ - <バックアップとリストア試験が完了している>
88
+ - <監視、連絡網、ロールバック環境が準備されている>
89
+ - <利用者通知と業務側の準備が完了している>
90
+
91
+ ## 本番移行タイムライン
92
+
93
+ | 時刻 | 手順ID | 作業 | 実行者 | 想定時間 | 完了条件 | 証跡 |
94
+ |---|---|---|---|---:|---|---|
95
+ | <HH:mm> | STEP-001 | <作業> | <担当> | <分> | <確認可能な条件> | <ログ・画面> |
96
+
97
+ ## 検証と照合
98
+
99
+ | 検証ID | 対象 | 検証方法 | 移行前値 | 移行後値 | 許容差 | 判定者 |
100
+ |---|---|---|---:|---:|---:|---|
101
+ | VAL-001 | 件数 | <SQL・レポート> | <値> | <値> | 0 | <担当> |
102
+ | VAL-002 | 金額・集計 | <照合方法> | <値> | <値> | <値> | <担当> |
103
+ | VAL-003 | 参照整合性 | <孤立・重複・外部キー検査> | <値> | <値> | 0 | <担当> |
104
+ | VAL-004 | 業務シナリオ | <操作> | <期待> | <実結果> | なし | <担当> |
105
+
106
+ ## Go / No-Go判定
107
+
108
+ | 判定時点 | Go条件 | No-Go条件 | 必要な証跡 | 判断者 |
109
+ |---|---|---|---|---|
110
+ | 移行開始前 | <条件> | <条件> | <チェックリスト> | <担当> |
111
+ | 切替前 | <条件> | <条件> | <移行・照合結果> | <担当> |
112
+ | サービス再開前 | <条件> | <条件> | <業務確認・監視> | <担当> |
113
+
114
+ ## ロールバック計画
115
+
116
+ - ロールバック可能期限: <時刻・条件>
117
+ - ロールバック判断条件: <時間超過、欠損、重大障害など>
118
+ - 判断者: <役割>
119
+ - データ整合性方針: <移行後更新の扱い>
120
+
121
+ | 手順 | 作業 | 実行者 | 想定時間 | 完了条件 |
122
+ |---:|---|---|---:|---|
123
+ | 1 | <新環境への書き込みを停止する> | <担当> | <分> | <条件> |
124
+ | 2 | <切替後に新環境へ書き込まれた差分を退避し、再適用・補償対象を確定する> | <担当> | <分> | <差分が固定され証跡がある> |
125
+ | 3 | <旧環境を復旧し、必要な差分を再適用または補償する> | <担当> | <分> | <整合性基準を満たす> |
126
+ | 4 | <データと業務を確認して旧環境を再開する> | <担当> | <分> | <再開条件を満たす> |
127
+
128
+ ## 業務継続と利用者コミュニケーション
129
+
130
+ | 対象 | 通知内容 | 通知時期 | 手段 | 担当 |
131
+ |---|---|---|---|---|
132
+ | 利用者 | <停止・変更・再開> | <時期> | <メール・画面> | <担当> |
133
+ | 問い合わせ窓口 | <FAQ・既知問題> | <時期> | <手段> | <担当> |
134
+ | 経営・顧客 | <進捗・障害> | <条件> | <手段> | <担当> |
135
+
136
+ - 停止中の代替業務: <手作業・受付停止など>
137
+ - 再開後の問い合わせ増加対応: <増員・期間>
138
+
139
+ ## セキュリティと監査
140
+
141
+ - 移行データの暗号化: <転送時・保存時>
142
+ - 一時ファイル: <保管場所・アクセス・削除期限>
143
+ - 特権アクセス: <申請・有効期限・監査>
144
+ - 個人情報・機密情報: <マスキング・取扱い>
145
+ - 操作証跡: <記録内容・保存期間>
146
+
147
+ ## 移行後の安定化
148
+
149
+ | 期間 | 監視強化項目 | 判定基準 | 担当 | 通常運用への移行条件 |
150
+ |---|---|---|---|---|
151
+ | <期間> | <エラー率・照合・問い合わせ> | <閾値> | <担当> | <条件> |
152
+
153
+ - 旧環境の扱い: <参照専用、保持期間、廃止日>
154
+ - 一時データ・権限の削除: <期限・証跡>
155
+ - 未移行・エラーデータの処理: <方法・期限>
156
+
157
+ ## リスクと未解決事項
158
+
159
+ | ID | 内容 | 影響 | 発生可能性 | 対策・期限 | 所有者 | ステータス |
160
+ |---|---|---|---|---|---|---|
161
+ | MIG-RSK-001 | <内容> | High / Medium / Low | High / Medium / Low | <対策> | <担当> | Open |
162
+
163
+ ## 承認記録
164
+
165
+ | 版 | 承認日 | 承認者 | 判断 | 条件・コメント |
166
+ |---|---|---|---|---|
167
+ | <版> | <YYYY-MM-DD> | <氏名・会議体> | Approved / Rejected / Deferred | <条件> |
168
+
169
+ ## 変更履歴
170
+
171
+ | 版 | 日付 | 変更内容 | 変更理由 | 作成者 |
172
+ |---|---|---|---|---|
173
+ | 0.1 | <YYYY-MM-DD> | 初版 | <理由> | <氏名> |
@@ -0,0 +1,202 @@
1
+ # <サービス名> 運用設計書・Runbook
2
+
3
+ <サービスを安定して監視・変更・復旧するために、運用担当者が実行する判断と手順を3文以内で要約する。>
4
+
5
+ - 文書版: <例: 1.0>
6
+ - 作成日: <YYYY-MM-DD>
7
+ - 最終更新日: <YYYY-MM-DD>
8
+ - サービス所有者: <チーム・責任者>
9
+ - 運用責任者: <チーム・責任者>
10
+ - ステータス: Draft / In Review / Approved
11
+ - 対象環境: Production / Staging / <その他>
12
+ - 関連設計書: <文書名・版・URL>
13
+
14
+ ## この運用設計で合意する事項
15
+
16
+ - 運用対象とサービス時間: <対象・時間帯>
17
+ - 運用体制: <担当、当番、委託先>
18
+ - サービス目標: <SLO・復旧目標>
19
+ - 承認を求める事項: <監視、権限、手順、残余リスク>
20
+
21
+ ## サービス概要と依存関係
22
+
23
+ | 項目 | 内容 |
24
+ |---|---|
25
+ | 利用者・業務 | <対象利用者と重要業務> |
26
+ | 主要機能 | <機能> |
27
+ | サービス時間 | <曜日・時間・計画停止> |
28
+ | 依存サービス | <クラウド、外部API、ネットワークなど> |
29
+ | データストア | <種類・場所> |
30
+ | 構成管理 | <IaC・設定リポジトリ> |
31
+ | ダッシュボード | <URL> |
32
+ | Issue・問い合わせ | <URL・窓口> |
33
+
34
+ ```mermaid
35
+ flowchart LR
36
+ U[<利用者>] --> S[<対象サービス>]
37
+ S --> D[(<データストア>)]
38
+ S --> E[<外部依存サービス>]
39
+ M[<監視基盤>] --> S
40
+ ```
41
+
42
+ ## サービスレベルと運用指標
43
+
44
+ | SLI | 測定方法 | SLO | 集計期間 | エラーバジェット | 未達時の対応 |
45
+ |---|---|---:|---|---:|---|
46
+ | <可用性・遅延など> | <式・データソース> | <値> | <期間> | <値> | <変更停止・改善> |
47
+
48
+ ## 運用体制と連絡経路
49
+
50
+ | 役割 | 担当 | 対応時間 | 責任 | 連絡方法 |
51
+ |---|---|---|---|---|
52
+ | サービス所有者 | <担当> | <時間帯> | <判断・予算> | <方法> |
53
+ | オンコール | <担当> | <時間帯> | <一次対応> | <方法> |
54
+ | セキュリティ | <担当> | <時間帯> | <事故対応> | <方法> |
55
+
56
+ ### エスカレーション
57
+
58
+ | 条件 | 一次連絡 | 二次連絡 | 経営・顧客連絡 | 期限 |
59
+ |---|---|---|---|---|
60
+ | <重大度・継続時間> | <担当> | <担当> | <担当> | <時間> |
61
+
62
+ ## 監視・ログ・アラート
63
+
64
+ | 監視ID | 対象 | シグナル | 閾値・条件 | 重要度 | 通知先 | Runbook節 |
65
+ |---|---|---|---|---|---|---|
66
+ | MON-001 | <対象> | <メトリクス・ログ> | <条件と継続時間> | Critical / Warning | <通知先> | <節名> |
67
+
68
+ - ログ保存期間: <期間>
69
+ - トレース・相関ID: <方式>
70
+ - 機密情報のマスキング: <対象・方式>
71
+ - 通知抑制・重複排除: <方式>
72
+ - アラート試験: <頻度・方法>
73
+
74
+ ## 日次・週次・月次の定常作業
75
+
76
+ | 頻度 | 作業 | 手順 | 完了条件 | 証跡 | 担当 |
77
+ |---|---|---|---|---|---|
78
+ | 日次 | <作業> | <コマンド・URL・手順> | <確認結果> | <保存先> | <担当> |
79
+ | 週次 | <作業> | <手順> | <確認結果> | <保存先> | <担当> |
80
+ | 月次 | <作業> | <手順> | <確認結果> | <保存先> | <担当> |
81
+
82
+ ## インシデントの重大度と初動
83
+
84
+ | 重大度 | 定義 | 例 | 応答期限 | 更新頻度 | 指揮権 |
85
+ |---|---|---|---|---|---|
86
+ | SEV-1 | <全停止・重大漏えいなど> | <例> | <時間> | <間隔> | <役割> |
87
+ | SEV-2 | <主要機能障害など> | <例> | <時間> | <間隔> | <役割> |
88
+ | SEV-3 / 4 | <限定影響> | <例> | <時間> | <間隔> | <役割> |
89
+
90
+ ### 共通初動
91
+
92
+ 1. <アラートと利用者影響を確認する。>
93
+ 2. <インシデントを起票し、指揮担当と記録担当を決める。>
94
+ 3. <直近変更、依存先、主要メトリクスを確認する。>
95
+ 4. <影響拡大を止めるための緩和策を実施する。>
96
+ 5. <定めた頻度で関係者へ状況を更新する。>
97
+ 6. <復旧を検証し、事後レビューを登録する。>
98
+
99
+ ## 症状別Runbook
100
+
101
+ ### <症状・アラート名>
102
+
103
+ - 検知条件: <アラート・問い合わせ>
104
+ - 利用者影響: <影響>
105
+ - 安全上の注意: <実行禁止条件・承認が必要な操作>
106
+
107
+ 1. <ダッシュボード・ログで事象を確認する。>
108
+ 2. <切り分けコマンドまたは画面操作を実行する。>
109
+ 3. <一時的な緩和策を実行する。>
110
+ 4. <正常化をSLIと利用者操作で確認する。>
111
+
112
+ - エスカレーション条件: <条件>
113
+ - 復旧しない場合: <代替手段・停止判断>
114
+ - 証跡: <保存するログ・時刻・操作>
115
+
116
+ ## 起動・停止・再起動
117
+
118
+ | 操作 | 実行条件 | 手順 | 正常性確認 | 失敗時の対応 | 承認 |
119
+ |---|---|---|---|---|---|
120
+ | 起動 | <条件> | <手順> | <ヘルスチェック> | <復旧> | <要否> |
121
+ | 停止 | <条件> | <手順> | <停止確認> | <復旧> | <要否> |
122
+ | 再起動 | <条件> | <手順> | <正常性確認> | <ロールバック> | <要否> |
123
+
124
+ ## バックアップとリストア
125
+
126
+ | 対象 | 方式 | 頻度 | 保持期間 | 暗号化 | 復元目標 | 復元試験 |
127
+ |---|---|---|---|---|---|---|
128
+ | <データ・設定> | <方式> | <頻度> | <期間> | <方式> | RTO / RPO | <頻度・証跡> |
129
+
130
+ ### リストア手順
131
+
132
+ - 前提・承認: <障害状況、復元時点、影響範囲、実行承認者>
133
+ - 復元先: <原則として隔離環境へ先行復元し、検証後に本番へ適用する>
134
+ - 失敗時の対応: <中止条件、再試行上限、エスカレーション先>
135
+ - 証跡: <承認、スナップショット、ログ、検証結果の保存先>
136
+
137
+ 1. <復元時点、影響範囲、復元先について承認を得る。>
138
+ 2. <現在状態のスナップショットと操作開始時刻を記録する。>
139
+ 3. <隔離環境へ復元し、バックアップの完全性と復元手順を検証する。>
140
+ 4. <本番への書き込み停止または対象データの隔離を実施する。>
141
+ 5. <承認済みの復元先へバックアップを復元する。>
142
+ 6. <件数、参照整合性、アプリケーション動作を検証する。>
143
+ 7. <サービスを再開し、監視結果と利用者影響を確認する。>
144
+ 8. <関係者へ結果を通知し、すべての証跡を保存する。>
145
+
146
+ ## セキュリティ運用
147
+
148
+ - 特権アクセス: <申請、承認、有効期限、記録>
149
+ - シークレット・鍵・証明書: <保管、更新、失効、期限監視>
150
+ - 脆弱性対応: <検知元、重大度、修正期限>
151
+ - 監査ログ: <対象、保存期間、確認頻度>
152
+ - セキュリティ事故: <隔離、証拠保全、連絡先>
153
+
154
+ ## 変更・リリース・ロールバック
155
+
156
+ | 変更区分 | 承認 | 実施時間帯 | 検証 | ロールバック条件 |
157
+ |---|---|---|---|---|
158
+ | 標準変更 | <承認者> | <時間帯> | <確認> | <条件> |
159
+ | 通常変更 | <承認者> | <時間帯> | <確認> | <条件> |
160
+ | 緊急変更 | <承認者> | <時間帯> | <事後確認> | <条件> |
161
+
162
+ - リリース手順: <パイプライン・段階展開>
163
+ - 変更前確認: <バックアップ・依存先・エラーバジェット>
164
+ - 変更後確認: <SLI・ログ・利用者シナリオ>
165
+ - ロールバック手順: <復旧先・データ互換性>
166
+
167
+ ## 容量・性能・コスト管理
168
+
169
+ | 指標 | 現在値 | 警告閾値 | 上限 | 拡張方法 | 確認頻度 |
170
+ |---|---:|---:|---:|---|---|
171
+ | <CPU・容量・件数・費用> | <値> | <値> | <値> | <方法> | <頻度> |
172
+
173
+ ## 災害復旧と事業継続
174
+
175
+ - 災害シナリオ: <リージョン障害・拠点喪失など>
176
+ - RTO / RPO: <値>
177
+ - 切替判断者: <役割>
178
+ - 切替・切戻し手順: <手順参照>
179
+ - 代替業務: <手作業・縮退運転>
180
+ - 訓練頻度と証跡: <頻度・保存先>
181
+
182
+ ## リスクと未解決事項
183
+
184
+ | ID | 内容 | 影響 | 対応・期限 | 所有者 | ステータス |
185
+ |---|---|---|---|---|---|
186
+ | OPS-RSK-001 | <内容> | <影響> | <対応> | <担当> | Open |
187
+
188
+ ## Runbookの有効性と陳腐化検知
189
+
190
+ - 定期レビュー期限: <例: 90日ごと>
191
+ - 臨時レビュー条件: <構成、依存先、権限、アラート、復旧方式の変更>
192
+ - 期限超過時の扱い: <警告、利用停止、再検証が必要な手順>
193
+
194
+ | Runbook・手順 | 最終実行・訓練日 | 検証した構成版 | 次回期限 | 所有者 | 状態 |
195
+ |---|---|---|---|---|---|
196
+ | <手順名> | <YYYY-MM-DD> | <バージョン・構成> | <YYYY-MM-DD> | <担当> | Current / Review Due / Stale |
197
+
198
+ ## レビューと変更履歴
199
+
200
+ | 版 | 日付 | 変更内容・訓練結果 | レビュー担当 | 次回見直し |
201
+ |---|---|---|---|---|
202
+ | 0.1 | <YYYY-MM-DD> | 初版 | <担当> | <YYYY-MM-DD> |
@@ -0,0 +1,23 @@
1
+ ## What
2
+
3
+ <What changed, 1–3 sentences>
4
+
5
+ ## Why
6
+
7
+ <Why it's needed. Related issue: #___>
8
+
9
+ ## How
10
+
11
+ <Main design decisions. Implementation detail is left to the diff>
12
+
13
+ ## How to verify
14
+
15
+ 1. <Concrete steps the reviewer can use to reproduce>
16
+
17
+ ## Impact / breaking changes
18
+
19
+ - <State explicitly if any; otherwise state "none">
20
+
21
+ ## Remaining work
22
+
23
+ - <If any>
@@ -0,0 +1,44 @@
1
+ ---
2
+ title: <記事タイトル>
3
+ tags:
4
+ - <tag1>
5
+ - <tag2>
6
+ private: false
7
+ organization_url_name: null
8
+ ---
9
+
10
+ <この記事が解決する具体的な課題と、読了後にできるようになることを記載する。>
11
+
12
+ # 検証した環境
13
+
14
+ | 項目 | バージョン・値 |
15
+ |---|---|
16
+ | OS | <OSとバージョン> |
17
+ | 言語・ランタイム | <名称とバージョン> |
18
+ | フレームワーク・ライブラリ | <名称とバージョン> |
19
+
20
+ # <最初に読者へ示す結論・解決方法>
21
+
22
+ <検索から到達した読者が最短で解決できるよう、結論または実行手順を先に記載する。>
23
+
24
+ ```bash
25
+ <そのまま実行できる最小のコマンド例>
26
+ ```
27
+
28
+ ## <手順の前提または補足>
29
+
30
+ <必要な権限、設定、注意点を記載する。>
31
+
32
+ # <仕組み・原因・技術的な説明>
33
+
34
+ <なぜこの方法で解決するのかを、図・コード・具体例を使って説明する。>
35
+
36
+ # 制約と未対応事項
37
+
38
+ - <確認できていない環境>
39
+ - <適用できない条件>
40
+ - <既知の制約>
41
+
42
+ # 参考資料
43
+
44
+ - [<公式ドキュメント名>](<URL>)
@@ -0,0 +1,38 @@
1
+ # <Project name>
2
+
3
+ <What this is, in one sentence>
4
+
5
+ ## <The problem this project solves>
6
+
7
+ <Problem → approach, 2–4 sentences>
8
+
9
+ ## What you can do
10
+
11
+ - <Feature 1 (start with a verb)>
12
+ - <Feature 2>
13
+
14
+ ## Setup
15
+
16
+ ### Prerequisites
17
+
18
+ - <Required versions, permissions, OS, etc.>
19
+
20
+ ### Install
21
+
22
+ ```bash
23
+ <Command(s) that run as copy-pasted>
24
+ ```
25
+
26
+ ## <Verb-first heading naming the smallest successful experience, e.g. "Generate your first README">
27
+
28
+ ```bash
29
+ <Command/code showing the smallest successful experience>
30
+ ```
31
+
32
+ ## Known limitations
33
+
34
+ - <What's not supported / caveats>
35
+
36
+ ## License
37
+
38
+ <License name>
@@ -0,0 +1,170 @@
1
+ # <システム・プロジェクト名> 要件定義書
2
+
3
+ <誰のどの課題を解決し、どの業務成果を実現するシステムかを3文以内で要約する。>
4
+
5
+ - 文書版: <例: 1.0>
6
+ - 作成日: <YYYY-MM-DD>
7
+ - 最終更新日: <YYYY-MM-DD>
8
+ - 作成者: <氏名・チーム>
9
+ - 承認者: <氏名・会議体>
10
+ - ステータス: Draft / In Review / Approved
11
+ - 対象リリース: <バージョン・時期>
12
+
13
+ ## この要件定義で合意する事項
14
+
15
+ - 対象範囲: <対象となる業務・利用者・システム>
16
+ - 期待する成果: <測定可能な業務成果>
17
+ - 承認を求める事項: <スコープ、優先順位、予算、納期など>
18
+
19
+ ## 背景と解決する課題
20
+
21
+ ### 現状
22
+
23
+ <現行業務や既存システムの状態を、数値や観測事実を用いて記載する。>
24
+
25
+ ### 解決する課題
26
+
27
+ | 課題ID | 課題 | 影響を受ける利用者・業務 | 現状値 | 解決後の目標値 |
28
+ |---|---|---|---:|---:|
29
+ | ISS-001 | <課題> | <対象> | <値> | <値> |
30
+
31
+ ## 目的と成功指標
32
+
33
+ | 目的ID | 目的 | 成功指標 | 現状値 | 目標値 | 測定方法 | 判定時期 |
34
+ |---|---|---|---:|---:|---|---|
35
+ | OBJ-001 | <目的> | <KPI・SLO> | <値> | <値> | <方法> | <時期> |
36
+
37
+ ## 対象範囲と対象外
38
+
39
+ ### 対象範囲
40
+
41
+ - <対象業務>
42
+ - <対象組織・利用者>
43
+ - <対象システム・データ>
44
+
45
+ ### 対象外
46
+
47
+ - <今回扱わない業務・機能>
48
+ - <将来フェーズへ送る事項>
49
+
50
+ ## ステークホルダーと利用者
51
+
52
+ | 区分 | 役割・利用者像 | 関心事 | 責任・権限 |
53
+ |---|---|---|---|
54
+ | <区分> | <役割> | <期待・懸念> | <承認・利用・運用など> |
55
+
56
+ ## 前提条件と制約
57
+
58
+ ### 前提条件
59
+
60
+ - <成立を前提とする業務・技術・契約条件>
61
+
62
+ ### 制約
63
+
64
+ | 制約ID | 分類 | 内容 | 要件・設計への影響 |
65
+ |---|---|---|---|
66
+ | CON-001 | 予算 / 納期 / 技術 / 法令 | <制約> | <影響> |
67
+
68
+ ## 業務要件
69
+
70
+ ### 対象業務の流れ
71
+
72
+ ```mermaid
73
+ flowchart LR
74
+ A[<開始条件>] --> B[<利用者の業務>]
75
+ B --> C[<システムによる処理>]
76
+ C --> D[<業務成果>]
77
+ ```
78
+
79
+ ### 業務ルール
80
+
81
+ | ルールID | 業務ルール | 適用条件 | 例外 | 根拠・所有者 |
82
+ |---|---|---|---|---|
83
+ | BR-001 | <ルール> | <条件> | <例外> | <規程・責任者> |
84
+
85
+ ## 機能要件
86
+
87
+ 優先度は Must / Should / Could / Won't を使用し、各要件は単独で検証できる粒度にする。
88
+
89
+ | 要件ID | 機能要件 | 利用者 | 事前条件 | 入力 | 処理・振る舞い | 出力・事後条件 | 優先度 | 受入条件 |
90
+ |---|---|---|---|---|---|---|---|---|
91
+ | FR-001 | <実現する能力> | <利用者> | <条件> | <入力> | <振る舞い> | <結果> | Must | <観測可能な合格条件> |
92
+
93
+ ## 非機能要件
94
+
95
+ 「高速」「安全」などの抽象語だけで終わらせず、測定条件と合格値を記載する。
96
+
97
+ | 要件ID | 分類 | 要件 | 測定条件 | 目標値 | 受入方法 | 優先度 |
98
+ |---|---|---|---|---:|---|---|
99
+ | NFR-001 | 性能 | <要件> | <負荷・データ量・時間帯> | <応答時間・スループット> | <試験方法> | Must |
100
+ | NFR-002 | 可用性 | <要件> | <対象時間帯・除外条件> | <稼働率・RTO・RPO> | <確認方法> | Must |
101
+ | NFR-003 | セキュリティ | <要件> | <脅威・データ区分> | <準拠基準・制御> | <監査・試験方法> | Must |
102
+
103
+ 対象となる分類:
104
+
105
+ - 性能・拡張性
106
+ - 可用性・信頼性・災害復旧
107
+ - セキュリティ・プライバシー・監査
108
+ - 保守性・運用性・監視
109
+ - アクセシビリティ・ユーザビリティ
110
+ - 互換性・移植性
111
+
112
+ ## データ要件
113
+
114
+ | データID | データ | 所有者 | 取得元 | 用途 | 機密区分 | 保持期間 | 品質条件 | 削除方法 |
115
+ |---|---|---|---|---|---|---|---|---|
116
+ | DATA-001 | <データ> | <責任者> | <取得元> | <用途> | <区分> | <期間> | <完全性・正確性> | <方法> |
117
+
118
+ ## 外部インターフェース要件
119
+
120
+ | IF-ID | 接続先 | 目的 | データ・操作 | 方式 | 認証・認可 | 頻度・量 | 障害時の扱い |
121
+ |---|---|---|---|---|---|---|---|
122
+ | IF-001 | <システム・利用者> | <目的> | <内容> | API / File / UI | <方式> | <頻度・件数> | <再試行・代替手段> |
123
+
124
+ ## 移行と導入の要件
125
+
126
+ - 移行対象: <データ・利用者・業務>
127
+ - 移行元と移行先: <システム・形式>
128
+ - 移行品質条件: <件数一致、欠損率、照合方法>
129
+ - 切替可能時間: <停止許容時間・実施時間帯>
130
+ - 並行稼働: <有無・期間・終了条件>
131
+ - 教育・周知: <対象者・方法・完了条件>
132
+ - ロールバック条件: <中止を判断する指標>
133
+
134
+ ## 運用・保守要件
135
+
136
+ | 項目 | 要件 | 担当 | サービス時間・期限 | エスカレーション |
137
+ |---|---|---|---|---|
138
+ | 監視 | <監視対象・通知条件> | <担当> | <時間帯> | <連絡経路> |
139
+ | 問い合わせ | <受付・対応範囲> | <担当> | <SLA> | <連絡経路> |
140
+ | 変更管理 | <申請・承認・リリース手順> | <担当> | <期限> | <連絡経路> |
141
+
142
+ ## 受入条件
143
+
144
+ | 受入ID | 対応要件ID | 検証内容 | 前提・テストデータ | 合格基準 | 証跡 | 判定者 |
145
+ |---|---|---|---|---|---|---|
146
+ | AC-001 | FR-001 | <検証内容> | <条件> | <合格基準> | <ログ・画面・報告書> | <役割> |
147
+
148
+ ## 要件トレーサビリティ
149
+
150
+ | 目的ID | 課題ID | 要件ID | 受入ID | 設計・実装先 | ステータス |
151
+ |---|---|---|---|---|---|
152
+ | OBJ-001 | ISS-001 | FR-001 | AC-001 | <設計書の節・Issue・PR> | Draft |
153
+
154
+ ## リスクと未解決事項
155
+
156
+ | ID | 区分 | 内容 | 影響 | 対応・決定期限 | 所有者 | ステータス |
157
+ |---|---|---|---|---|---|---|
158
+ | RSK-001 | リスク / 未解決事項 | <内容> | <影響> | <対応・期限> | <担当> | Open |
159
+
160
+ ## 承認記録
161
+
162
+ | 版 | 承認日 | 承認者 | 判断 | 条件・コメント |
163
+ |---|---|---|---|---|
164
+ | <版> | <YYYY-MM-DD> | <氏名・会議体> | Approved / Rejected / Deferred | <条件> |
165
+
166
+ ## 変更履歴
167
+
168
+ | 版 | 日付 | 変更内容 | 変更理由 | 作成者 |
169
+ |---|---|---|---|---|
170
+ | 0.1 | <YYYY-MM-DD> | 初版 | <理由> | <氏名> |