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.
- package/.github/skills/ai-chemistry-scientist/SKILL.md +97 -0
- package/.github/skills/ai-chemistry-scientist/manifest.json +156 -0
- package/.github/skills/ai-data-scientist/SKILL.md +330 -0
- package/.github/skills/ai-genomics-scientist/SKILL.md +98 -0
- package/.github/skills/ai-genomics-scientist/manifest.json +93 -0
- package/.github/skills/ai-materials-scientist/SKILL.md +51 -0
- package/.github/skills/ai-materials-scientist/manifest.json +58 -0
- package/.github/skills/ai-scientist/SKILL.md +69 -0
- package/.github/skills/ai-scientist/manifest.json +61 -0
- package/.github/skills/ai-structural-biology-scientist/SKILL.md +67 -0
- package/.github/skills/ai-structural-biology-scientist/manifest.json +72 -0
- package/.github/skills/japanese-prose/NOTICE.md +17 -0
- package/.github/skills/japanese-prose/SKILL.md +111 -0
- package/.github/skills/japanese-prose/references/review-workflow.md +50 -0
- package/.github/skills/japanese-prose/references/scoring.md +24 -0
- package/.github/skills/japanese-prose/references/writing-guidelines.md +60 -0
- package/.github/skills/japanese-prose/scripts/core.py +192 -0
- package/.github/skills/japanese-prose/scripts/fixtures/natural.md +5 -0
- package/.github/skills/japanese-prose/scripts/fixtures/unnatural.md +5 -0
- package/.github/skills/japanese-prose/scripts/lint.py +378 -0
- package/.github/skills/japanese-prose/scripts/outline.py +68 -0
- package/.github/skills/japanese-prose/scripts/terms.py +112 -0
- package/.github/skills/japanese-prose/scripts/test_engine.py +117 -0
- package/.github/skills/presentation-planner/SKILL.md +257 -0
- package/.github/skills/presentation-planner/assets/design-templates/data-report.yaml +97 -0
- package/.github/skills/presentation-planner/assets/design-templates/executive-proposal.yaml +92 -0
- package/.github/skills/presentation-planner/assets/design-templates/technical-briefing.yaml +96 -0
- package/.github/skills/presentation-planner/assets/scenario-templates/data-report.md +47 -0
- package/.github/skills/presentation-planner/assets/scenario-templates/executive-decision.md +43 -0
- package/.github/skills/presentation-planner/assets/scenario-templates/technical-briefing.md +45 -0
- package/.github/skills/presentation-planner/references/customizing-design-templates.md +160 -0
- package/.github/skills/presentation-planner/references/design-spec-schema.md +72 -0
- package/.github/skills/presentation-planner/references/handoff-contract.md +49 -0
- package/.github/skills/presentation-planner/references/responsibility-boundary.md +32 -0
- package/.github/skills/presentation-planner/references/scenario-templates.md +55 -0
- package/.github/skills/tech-writer/SKILL.md +434 -0
- package/.github/skills/tech-writer/assets/templates/blueprint.md +187 -0
- package/.github/skills/tech-writer/assets/templates/design-doc.md +29 -0
- package/.github/skills/tech-writer/assets/templates/migration-plan.md +173 -0
- package/.github/skills/tech-writer/assets/templates/operations-runbook.md +202 -0
- package/.github/skills/tech-writer/assets/templates/pr-description.md +23 -0
- package/.github/skills/tech-writer/assets/templates/qiita.md +44 -0
- package/.github/skills/tech-writer/assets/templates/readme.md +38 -0
- package/.github/skills/tech-writer/assets/templates/requirements-definition.md +170 -0
- package/.github/skills/tech-writer/assets/templates/rfi.md +113 -0
- package/.github/skills/tech-writer/assets/templates/rfp.md +180 -0
- package/.github/skills/tech-writer/assets/templates/security-design.md +167 -0
- package/.github/skills/tech-writer/assets/templates/system-design.md +220 -0
- package/.github/skills/tech-writer/assets/templates/technical-proposal.md +112 -0
- package/.github/skills/tech-writer/assets/templates/test-plan.md +153 -0
- package/.github/skills/tech-writer/assets/templates/user-manual.md +22 -0
- package/.github/skills/tech-writer/assets/templates/white-paper.md +192 -0
- package/.github/skills/tech-writer/references/doctypes/api-docs.md +33 -0
- package/.github/skills/tech-writer/references/doctypes/blueprint.md +81 -0
- package/.github/skills/tech-writer/references/doctypes/code-comments.md +39 -0
- package/.github/skills/tech-writer/references/doctypes/design-doc.md +42 -0
- package/.github/skills/tech-writer/references/doctypes/migration-plan.md +63 -0
- package/.github/skills/tech-writer/references/doctypes/operations-runbook.md +63 -0
- package/.github/skills/tech-writer/references/doctypes/pr-commit.md +82 -0
- package/.github/skills/tech-writer/references/doctypes/qiita.md +75 -0
- package/.github/skills/tech-writer/references/doctypes/readme.md +43 -0
- package/.github/skills/tech-writer/references/doctypes/release-notes.md +30 -0
- package/.github/skills/tech-writer/references/doctypes/requirements-definition.md +61 -0
- package/.github/skills/tech-writer/references/doctypes/rfi.md +43 -0
- package/.github/skills/tech-writer/references/doctypes/rfp.md +46 -0
- package/.github/skills/tech-writer/references/doctypes/security-design.md +71 -0
- package/.github/skills/tech-writer/references/doctypes/system-design.md +74 -0
- package/.github/skills/tech-writer/references/doctypes/technical-proposal.md +49 -0
- package/.github/skills/tech-writer/references/doctypes/test-plan.md +67 -0
- package/.github/skills/tech-writer/references/doctypes/user-manual.md +58 -0
- package/.github/skills/tech-writer/references/doctypes/white-paper.md +84 -0
- package/.github/skills/tech-writer/references/doctypes/zenn.md +66 -0
- package/.github/skills/tech-writer/references/japanese-prose-optimization.md +110 -0
- package/.github/skills/tech-writer/references/style-constitution.md +104 -0
- package/.github/skills/tech-writer/scripts/lint.py +412 -0
- package/LICENSE +21 -0
- package/README.md +92 -0
- package/bin/ai-data-scientist.js +123 -0
- package/package.json +41 -0
- package/pyproject.toml +45 -0
- package/src/ai_chemistry_scientist/__init__.py +0 -0
- package/src/ai_chemistry_scientist/admet_prediction.py +71 -0
- package/src/ai_chemistry_scientist/bioactivity_classification.py +73 -0
- package/src/ai_chemistry_scientist/data/sample_molecules.csv +21 -0
- package/src/ai_chemistry_scientist/dispatch.py +369 -0
- package/src/ai_chemistry_scientist/docking_score.py +97 -0
- package/src/ai_chemistry_scientist/drug_likeness_rules.py +84 -0
- package/src/ai_chemistry_scientist/evidence.py +41 -0
- package/src/ai_chemistry_scientist/molecular_descriptors.py +97 -0
- package/src/ai_chemistry_scientist/molecular_formula_mass.py +40 -0
- package/src/ai_chemistry_scientist/molecular_similarity.py +78 -0
- package/src/ai_chemistry_scientist/qsar_modeling.py +105 -0
- package/src/ai_chemistry_scientist/salt_standardization.py +81 -0
- package/src/ai_chemistry_scientist/structural_alerts.py +76 -0
- package/src/ai_chemistry_scientist/structure_format_conversion.py +84 -0
- package/src/ai_chemistry_scientist/validation.py +70 -0
- package/src/ai_data_scientist/__init__.py +0 -0
- package/src/ai_data_scientist/analysis_assumptions.py +121 -0
- package/src/ai_data_scientist/anomaly_detection.py +39 -0
- package/src/ai_data_scientist/automl.py +109 -0
- package/src/ai_data_scientist/cleaning.py +56 -0
- package/src/ai_data_scientist/cli.py +90 -0
- package/src/ai_data_scientist/clustering.py +54 -0
- package/src/ai_data_scientist/dashboard.py +33 -0
- package/src/ai_data_scientist/data_definition.py +100 -0
- package/src/ai_data_scientist/data_quality.py +164 -0
- package/src/ai_data_scientist/dataset_validation.py +135 -0
- package/src/ai_data_scientist/dependency_pins.py +60 -0
- package/src/ai_data_scientist/eda.py +82 -0
- package/src/ai_data_scientist/experiment_evaluation.py +635 -0
- package/src/ai_data_scientist/explainability.py +340 -0
- package/src/ai_data_scientist/feature_engineering.py +163 -0
- package/src/ai_data_scientist/gate_config.py +32 -0
- package/src/ai_data_scientist/ingestion.py +127 -0
- package/src/ai_data_scientist/insight_engine.py +180 -0
- package/src/ai_data_scientist/japanese_nlp.py +43 -0
- package/src/ai_data_scientist/jupyter_launcher.py +137 -0
- package/src/ai_data_scientist/jupyter_mcp_client.py +94 -0
- package/src/ai_data_scientist/language_router.py +28 -0
- package/src/ai_data_scientist/lifecycle.py +221 -0
- package/src/ai_data_scientist/mcp_gateway.py +113 -0
- package/src/ai_data_scientist/mcp_runtime.py +194 -0
- package/src/ai_data_scientist/mcp_transport.py +53 -0
- package/src/ai_data_scientist/ml_modeling.py +451 -0
- package/src/ai_data_scientist/model_tuning.py +104 -0
- package/src/ai_data_scientist/notebook_audit.py +574 -0
- package/src/ai_data_scientist/project_manager.py +243 -0
- package/src/ai_data_scientist/report_export.py +73 -0
- package/src/ai_data_scientist/sensitivity.py +445 -0
- package/src/ai_data_scientist/signal_analysis.py +201 -0
- package/src/ai_data_scientist/skill_packaging.py +40 -0
- package/src/ai_data_scientist/stats_analysis.py +88 -0
- package/src/ai_data_scientist/text_nlp.py +44 -0
- package/src/ai_data_scientist/timeseries.py +68 -0
- package/src/ai_data_scientist/visualization.py +708 -0
- package/src/ai_genomics_scientist/__init__.py +1 -0
- package/src/ai_genomics_scientist/differential_expression.py +147 -0
- package/src/ai_genomics_scientist/dispatch.py +267 -0
- package/src/ai_genomics_scientist/evidence.py +45 -0
- package/src/ai_genomics_scientist/gene_set_enrichment.py +76 -0
- package/src/ai_genomics_scientist/sequence_alignment.py +97 -0
- package/src/ai_genomics_scientist/sequence_features.py +111 -0
- package/src/ai_genomics_scientist/splice_site_scoring.py +66 -0
- package/src/ai_genomics_scientist/validation.py +83 -0
- package/src/ai_genomics_scientist/variant_effect.py +147 -0
- package/src/ai_genomics_scientist/variant_pathogenicity.py +125 -0
- package/src/ai_materials_scientist/__init__.py +0 -0
- package/src/ai_materials_scientist/calphad.py +117 -0
- package/src/ai_materials_scientist/classical_monte_carlo.py +165 -0
- package/src/ai_materials_scientist/crystal_plasticity.py +184 -0
- package/src/ai_materials_scientist/dispatch.py +100 -0
- package/src/ai_materials_scientist/evidence.py +84 -0
- package/src/ai_materials_scientist/fem.py +279 -0
- package/src/ai_materials_scientist/kinetic_monte_carlo.py +145 -0
- package/src/ai_materials_scientist/molecular_dynamics.py +240 -0
- package/src/ai_materials_scientist/phase_field.py +167 -0
- package/src/ai_materials_scientist/validation.py +70 -0
- package/src/ai_scientist/__init__.py +1 -0
- package/src/ai_scientist/completion_gate.py +15 -0
- package/src/ai_scientist/data_analysis.py +46 -0
- package/src/ai_scientist/evidence_registry.py +99 -0
- package/src/ai_scientist/experimental_design.py +20 -0
- package/src/ai_scientist/language.py +14 -0
- package/src/ai_scientist/latex_renderer.py +41 -0
- package/src/ai_scientist/literature_review.py +37 -0
- package/src/ai_scientist/manifest.py +87 -0
- package/src/ai_scientist/manuscript.py +94 -0
- package/src/ai_scientist/mcp_config.py +76 -0
- package/src/ai_scientist/mcp_external.py +42 -0
- package/src/ai_scientist/mcp_failures.py +23 -0
- package/src/ai_scientist/mcp_gateway.py +38 -0
- package/src/ai_scientist/mcp_managed.py +180 -0
- package/src/ai_scientist/npm_packaging.py +49 -0
- package/src/ai_scientist/orchestrator.py +133 -0
- package/src/ai_scientist/peer_review.py +60 -0
- package/src/ai_scientist/phase_gate.py +74 -0
- package/src/ai_scientist/phase_state.py +230 -0
- package/src/ai_scientist/presentation.py +56 -0
- package/src/ai_scientist/project_config.py +31 -0
- package/src/ai_scientist/project_handle.py +74 -0
- package/src/ai_scientist/reproducibility.py +20 -0
- package/src/ai_scientist/research_planning.py +20 -0
- package/src/ai_scientist/skill_invocation.py +21 -0
- package/src/ai_scientist/tdd_gate.py +99 -0
- package/src/ai_structural_biology_scientist/__init__.py +0 -0
- package/src/ai_structural_biology_scientist/contact_map.py +87 -0
- package/src/ai_structural_biology_scientist/dispatch.py +269 -0
- package/src/ai_structural_biology_scientist/evidence.py +43 -0
- package/src/ai_structural_biology_scientist/hydrophobicity.py +101 -0
- package/src/ai_structural_biology_scientist/protein_docking_score.py +104 -0
- package/src/ai_structural_biology_scientist/secondary_structure.py +95 -0
- package/src/ai_structural_biology_scientist/structural_similarity.py +74 -0
- package/src/ai_structural_biology_scientist/validation.py +100 -0
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
# <提案名>
|
|
2
|
+
|
|
3
|
+
<解決する課題、提案内容、期待する成果を3文以内で要約する。>
|
|
4
|
+
|
|
5
|
+
- 提案者: <氏名・チーム>
|
|
6
|
+
- 提案日: <YYYY-MM-DD>
|
|
7
|
+
- 対象読者: <意思決定者・レビュー担当者>
|
|
8
|
+
- ステータス: Draft / In Review / Approved / Rejected
|
|
9
|
+
- 承認を求める事項: <承認・却下してほしい判断>
|
|
10
|
+
|
|
11
|
+
## <この提案が必要な背景>
|
|
12
|
+
|
|
13
|
+
<現在の状況、観測された問題、今対応する理由を事実ベースで記載する。>
|
|
14
|
+
|
|
15
|
+
## 達成する目標と対象外
|
|
16
|
+
|
|
17
|
+
### 目標
|
|
18
|
+
|
|
19
|
+
- <測定可能な目標>
|
|
20
|
+
- <利用者または事業にもたらす成果>
|
|
21
|
+
|
|
22
|
+
### 対象外
|
|
23
|
+
|
|
24
|
+
- <今回の提案では扱わない事項>
|
|
25
|
+
|
|
26
|
+
## 提案する技術的アプローチ
|
|
27
|
+
|
|
28
|
+
<採用する方式を最初の1文で明示し、その後に構成と処理の流れを説明する。>
|
|
29
|
+
|
|
30
|
+
```mermaid
|
|
31
|
+
flowchart LR
|
|
32
|
+
A[<入力>] --> B[<主要コンポーネント>]
|
|
33
|
+
B --> C[<出力>]
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### 主要コンポーネント
|
|
37
|
+
|
|
38
|
+
| コンポーネント | 役割 | 採用技術 | 選定理由 |
|
|
39
|
+
|---|---|---|---|
|
|
40
|
+
| <名称> | <役割> | <製品・サービス> | <理由> |
|
|
41
|
+
|
|
42
|
+
### データとインターフェース
|
|
43
|
+
|
|
44
|
+
- 入力データ: <形式・取得元>
|
|
45
|
+
- 出力データ: <形式・保存先>
|
|
46
|
+
- 外部連携: <API・プロトコル・認証方式>
|
|
47
|
+
|
|
48
|
+
## セキュリティとコンプライアンス
|
|
49
|
+
|
|
50
|
+
- 認証・認可: <方式と権限モデル>
|
|
51
|
+
- データ保護: <暗号化・保持期間・削除方法>
|
|
52
|
+
- 監査: <ログ・追跡方法>
|
|
53
|
+
- 適用基準: <法令・社内規程・認証>
|
|
54
|
+
|
|
55
|
+
## 実施計画
|
|
56
|
+
|
|
57
|
+
| フェーズ | 作業 | 成果物 | 完了条件 | 期間 |
|
|
58
|
+
|---|---|---|---|---|
|
|
59
|
+
| <フェーズ名> | <作業内容> | <成果物> | <確認可能な条件> | <期間> |
|
|
60
|
+
|
|
61
|
+
### ロールアウトとロールバック
|
|
62
|
+
|
|
63
|
+
- ロールアウト: <段階導入・移行方法>
|
|
64
|
+
- ロールバック条件: <中止を判断する指標>
|
|
65
|
+
- ロールバック手順: <元の状態へ戻す方法>
|
|
66
|
+
|
|
67
|
+
## 必要な費用と体制
|
|
68
|
+
|
|
69
|
+
- TCO評価期間: <例: 導入から5年間>
|
|
70
|
+
- 通貨・税区分: <通貨・税込/税別>
|
|
71
|
+
|
|
72
|
+
| 項目 | 初期費用 | 年間継続費用 | 評価期間TCO | 前提条件 | 必要な担当・工数 |
|
|
73
|
+
|---|---:|---:|---:|---|---|
|
|
74
|
+
| <項目> | <金額> | <年額> | <金額> | <条件> | <役割・人日> |
|
|
75
|
+
| **合計** | **<合計>** | **<合計>** | **<初期費用+評価期間の継続費用>** | | |
|
|
76
|
+
|
|
77
|
+
## 共通の評価軸で代替案を比較する
|
|
78
|
+
|
|
79
|
+
| 選択肢 | 評価期間TCO | 導入期間 | 実装・運用工数 | リスク | 採否と理由 |
|
|
80
|
+
|---|---:|---|---|---|---|
|
|
81
|
+
| 現状維持 | <金額> | なし | <工数> | <継続する課題> | 不採用 / 採用: <理由> |
|
|
82
|
+
| 提案方式 | <金額> | <期間> | <工数> | <リスク> | 採用 / 不採用: <理由> |
|
|
83
|
+
| <代替案> | <金額> | <期間> | <工数> | <リスク> | 採用 / 不採用: <理由> |
|
|
84
|
+
|
|
85
|
+
## リスクと対策
|
|
86
|
+
|
|
87
|
+
| リスク | 影響 | 発生可能性 | 対策 | 所有者 |
|
|
88
|
+
|---|---|---|---|---|
|
|
89
|
+
| <リスク> | High / Medium / Low | High / Medium / Low | <予防・軽減策> | <担当> |
|
|
90
|
+
|
|
91
|
+
## 成功を判断する指標
|
|
92
|
+
|
|
93
|
+
| 指標 | 現状値 | 目標値 | 測定方法 | 判定時期 | 未達時の対応 |
|
|
94
|
+
|---|---:|---:|---|---|---|
|
|
95
|
+
| <指標> | <値> | <値> | <方法> | <日付・時点> | <改善・縮小・撤退判断> |
|
|
96
|
+
|
|
97
|
+
## 意思決定事項と未解決事項
|
|
98
|
+
|
|
99
|
+
### 承認条件の補足
|
|
100
|
+
|
|
101
|
+
<ヘッダーの「承認を求める事項」は繰り返さず、条件付き承認に必要な補足だけを記載する。>
|
|
102
|
+
|
|
103
|
+
### 未解決事項
|
|
104
|
+
|
|
105
|
+
- <追加調査または合意が必要な事項>
|
|
106
|
+
|
|
107
|
+
### 決定記録
|
|
108
|
+
|
|
109
|
+
- 決定: Approved / Rejected / Deferred
|
|
110
|
+
- 決定者: <氏名・会議体>
|
|
111
|
+
- 決定日: <YYYY-MM-DD>
|
|
112
|
+
- 条件・コメント: <承認条件または却下理由>
|
|
@@ -0,0 +1,153 @@
|
|
|
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
|
+
- 要件ベースライン: <要件定義書の文書名・版・URL>
|
|
13
|
+
- 設計ベースライン: <設計書の文書名・版・URL>
|
|
14
|
+
- セキュリティ設計ベースライン: <セキュリティ設計書の文書名・版・URL / N/A>
|
|
15
|
+
|
|
16
|
+
## このテスト計画で合意する事項
|
|
17
|
+
|
|
18
|
+
- テスト対象と対象外: <システム・機能・品質特性>
|
|
19
|
+
- 合否判定基準: <リリース可否を決める基準>
|
|
20
|
+
- 承認を求める事項: <範囲、環境、日程、体制、残余リスク>
|
|
21
|
+
|
|
22
|
+
## テストの目的と品質目標
|
|
23
|
+
|
|
24
|
+
| 目的ID | 品質目標 | 対応要件ID | 測定指標 | 合格値 |
|
|
25
|
+
|---|---|---|---|---:|
|
|
26
|
+
| T-OBJ-001 | <検証する品質> | FR-001 / NFR-001 | <指標> | <値> |
|
|
27
|
+
|
|
28
|
+
## 対象範囲と対象外
|
|
29
|
+
|
|
30
|
+
### 対象範囲
|
|
31
|
+
|
|
32
|
+
- <対象機能・コンポーネント・インターフェース>
|
|
33
|
+
- <対象ブラウザー・端末・OS・環境>
|
|
34
|
+
|
|
35
|
+
### 対象外
|
|
36
|
+
|
|
37
|
+
- <今回実施しない試験>
|
|
38
|
+
- <別チーム・別フェーズが担当する試験>
|
|
39
|
+
|
|
40
|
+
## 品質リスク
|
|
41
|
+
|
|
42
|
+
| リスクID | 想定する障害・品質リスク | 影響 | 発生可能性 | 検出するテスト | 優先度 |
|
|
43
|
+
|---|---|---|---|---|---|
|
|
44
|
+
| QR-001 | <リスク> | High / Medium / Low | High / Medium / Low | <テスト種別> | <順位> |
|
|
45
|
+
|
|
46
|
+
## テスト戦略
|
|
47
|
+
|
|
48
|
+
| テストレベル・種別 | 目的 | 対象 | 実施者 | 自動化方針 | 完了条件 |
|
|
49
|
+
|---|---|---|---|---|---|
|
|
50
|
+
| 単体テスト | <目的> | <対象> | <担当> | <範囲・ツール> | <条件> |
|
|
51
|
+
| 結合テスト | <目的> | <対象> | <担当> | <範囲・ツール> | <条件> |
|
|
52
|
+
| システムテスト | <目的> | <対象> | <担当> | <範囲・ツール> | <条件> |
|
|
53
|
+
| 受入テスト | <目的> | <対象> | <判定者> | <範囲・ツール> | <条件> |
|
|
54
|
+
|
|
55
|
+
### 非機能テスト
|
|
56
|
+
|
|
57
|
+
| 種別 | 対応要件ID | 条件・負荷 | 測定項目 | 合格基準 | 実施方法 |
|
|
58
|
+
|---|---|---|---|---|---|
|
|
59
|
+
| 性能・容量 | NFR-001 | <同時数・データ量> | <応答時間・TPS> | <値> | <方法・ツール> |
|
|
60
|
+
| 可用性・復旧 | NFR-002 | <障害条件> | <RTO・RPO> | <値> | <方法> |
|
|
61
|
+
| セキュリティ | NFR-003 | <脅威・権限> | <検証項目> | <基準> | <診断・試験> |
|
|
62
|
+
|
|
63
|
+
## テスト環境
|
|
64
|
+
|
|
65
|
+
| 環境 | 用途 | 構成 | 本番との差分 | 利用期間 | 管理者 |
|
|
66
|
+
|---|---|---|---|---|---|
|
|
67
|
+
| <環境名> | <用途> | <アプリ・基盤・外部接続> | <差分と影響> | <期間> | <担当> |
|
|
68
|
+
|
|
69
|
+
### 環境の準備条件
|
|
70
|
+
|
|
71
|
+
- ビルド・構成版: <バージョン・コミット>
|
|
72
|
+
- 外部サービス: <実接続 / Stub / Mock>
|
|
73
|
+
- 監視・ログ: <取得方法・保存先>
|
|
74
|
+
- リセット方法: <初期化・再作成手順>
|
|
75
|
+
|
|
76
|
+
## テストデータ
|
|
77
|
+
|
|
78
|
+
| データセット | 用途 | 作成・取得方法 | 機密区分 | マスキング | 初期化・削除 |
|
|
79
|
+
|---|---|---|---|---|---|
|
|
80
|
+
| <名称> | <テスト目的> | <生成・複製> | <区分> | <方法> | <方法> |
|
|
81
|
+
|
|
82
|
+
## 開始条件と終了条件
|
|
83
|
+
|
|
84
|
+
### 開始条件
|
|
85
|
+
|
|
86
|
+
- <対象ビルドが配置済み>
|
|
87
|
+
- <環境・データ・アカウントが準備済み>
|
|
88
|
+
- <重大な前工程不具合が解消済み>
|
|
89
|
+
|
|
90
|
+
### 終了条件
|
|
91
|
+
|
|
92
|
+
| 判定項目 | 合格条件 | 証跡 | 判定者 |
|
|
93
|
+
|---|---|---|---|
|
|
94
|
+
| テスト実行 | <必須ケース実行率など> | <レポート> | <役割> |
|
|
95
|
+
| 不具合 | <重大度別の残存許容数> | <一覧> | <役割> |
|
|
96
|
+
| 要件網羅 | <Must要件100%など> | <トレーサビリティ表> | <役割> |
|
|
97
|
+
| 残余リスク | <受容条件> | <承認記録> | <役割> |
|
|
98
|
+
|
|
99
|
+
### 中断条件と再開条件
|
|
100
|
+
|
|
101
|
+
| 中断条件 | 判断者 | 必要な対応 | 再開条件 | 再開承認者 |
|
|
102
|
+
|---|---|---|---|---|
|
|
103
|
+
| <環境障害、重大不具合、前提崩れなど> | <役割> | <修正・再構築・影響分析> | <環境確認、修正版配置、再テスト範囲の合意> | <役割> |
|
|
104
|
+
|
|
105
|
+
## テストケースと要件トレーサビリティ
|
|
106
|
+
|
|
107
|
+
| テストID | 対応要件ID | 対応セキュリティ試験ID | 対応脅威ID | 対応制御ID | シナリオ | 事前条件 | 操作・入力 | 期待結果 | 優先度 | 自動化 |
|
|
108
|
+
|---|---|---|---|---|---|---|---|---|---|---|
|
|
109
|
+
| TC-001 | FR-001 / AC-001 | SEC-TC-001 / N/A | THR-001 / N/A | CTRL-001 / N/A | <シナリオ> | <条件> | <操作> | <観測可能な結果> | Must | Yes / No |
|
|
110
|
+
|
|
111
|
+
## 不具合管理
|
|
112
|
+
|
|
113
|
+
| 重大度 | 定義 | 初動期限 | 修正・判断期限 | リリース判定 |
|
|
114
|
+
|---|---|---|---|---|
|
|
115
|
+
| Critical | <サービス停止・情報漏えいなど> | <時間> | <期限> | 原則不可 |
|
|
116
|
+
| High | <主要機能が利用不能など> | <時間> | <期限> | <例外承認条件> |
|
|
117
|
+
| Medium / Low | <影響> | <時間> | <期限> | <許容条件> |
|
|
118
|
+
|
|
119
|
+
- 登録先: <Issue tracker>
|
|
120
|
+
- 必須情報: <再現手順、期待結果、実結果、環境、証跡>
|
|
121
|
+
- 再テスト: <修正確認と回帰テストの範囲>
|
|
122
|
+
- 重複・却下・延期: <判断権限と記録方法>
|
|
123
|
+
|
|
124
|
+
## スケジュールと体制
|
|
125
|
+
|
|
126
|
+
| フェーズ | 作業 | 期間 | 担当 | 入力 | 成果物 |
|
|
127
|
+
|---|---|---|---|---|---|
|
|
128
|
+
| <フェーズ> | <作業> | <期間> | <担当> | <入力> | <レポート・証跡> |
|
|
129
|
+
|
|
130
|
+
## テスト結果と証跡
|
|
131
|
+
|
|
132
|
+
- 実行結果の保存先: <URL・リポジトリ>
|
|
133
|
+
- ログ・画面・計測値の保存方法: <方法>
|
|
134
|
+
- テストサマリーの更新頻度: <日次・フェーズ終了時>
|
|
135
|
+
- 最終報告の内容: <実行数、成功率、不具合、残余リスク>
|
|
136
|
+
|
|
137
|
+
## リスクと未解決事項
|
|
138
|
+
|
|
139
|
+
| ID | 内容 | 影響 | 対応・期限 | 所有者 | ステータス |
|
|
140
|
+
|---|---|---|---|---|---|
|
|
141
|
+
| T-RSK-001 | <環境遅延・データ不足など> | <影響> | <対応> | <担当> | Open |
|
|
142
|
+
|
|
143
|
+
## 承認記録
|
|
144
|
+
|
|
145
|
+
| 版 | 承認日 | 承認者 | 判断 | 残余リスク・条件 |
|
|
146
|
+
|---|---|---|---|---|
|
|
147
|
+
| <版> | <YYYY-MM-DD> | <氏名・会議体> | Approved / Rejected / Deferred | <条件> |
|
|
148
|
+
|
|
149
|
+
## 変更履歴
|
|
150
|
+
|
|
151
|
+
| 版 | 日付 | 変更内容 | 変更理由 | 作成者 |
|
|
152
|
+
|---|---|---|---|---|
|
|
153
|
+
| 0.1 | <YYYY-MM-DD> | 初版 | <理由> | <氏名> |
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# <What this guide gets you>
|
|
2
|
+
|
|
3
|
+
Target reader: <floor of prior knowledge assumed>
|
|
4
|
+
|
|
5
|
+
## Prerequisites
|
|
6
|
+
|
|
7
|
+
- <Required permissions, environment, pre-installs>
|
|
8
|
+
|
|
9
|
+
## Steps
|
|
10
|
+
|
|
11
|
+
1. <Action> — after running this, you'll see <state change>.
|
|
12
|
+
2. <Action> — after running this, you'll see <state change>.
|
|
13
|
+
|
|
14
|
+
## Completion check
|
|
15
|
+
|
|
16
|
+
<What should be displayed/generated to confirm success>
|
|
17
|
+
|
|
18
|
+
## Troubleshooting
|
|
19
|
+
|
|
20
|
+
| Symptom | Cause | Fix |
|
|
21
|
+
|---|---|---|
|
|
22
|
+
| <...> | <...> | <...> |
|
|
@@ -0,0 +1,192 @@
|
|
|
1
|
+
# <White Paperタイトル>
|
|
2
|
+
|
|
3
|
+
<対象読者が抱える問題、本書の中心的な結論、読後に判断できることを3文以内で記載する。>
|
|
4
|
+
|
|
5
|
+
- 発行者: <組織名>
|
|
6
|
+
- 著者・監修者: <氏名・役割>
|
|
7
|
+
- 発行日: <YYYY-MM-DD>
|
|
8
|
+
- 最終更新日: <YYYY-MM-DD>
|
|
9
|
+
- 版: <版番号>
|
|
10
|
+
- ステータス: Draft / In Review / Approved for Publication / Withdrawn
|
|
11
|
+
- 公開承認者: <氏名・役割・会議体>
|
|
12
|
+
- 法務・コンプライアンス・主張レビュー: <レビュー者・該当なし>
|
|
13
|
+
- 対象読者: <読者>
|
|
14
|
+
- 対象地域・業界: <範囲>
|
|
15
|
+
- 調査対象期間: <YYYY-MM-DD〜YYYY-MM-DD>
|
|
16
|
+
- 公開区分: Public / Limited / Confidential
|
|
17
|
+
- Analysis status: Completed / Incomplete / Not performed
|
|
18
|
+
- Evidence gaps: <不足する証拠、影響する判断、収集担当・期限、またはなし>
|
|
19
|
+
- 分析ハンドオフ: <synthesis-handoff.mdの所在、またはなし>
|
|
20
|
+
|
|
21
|
+
`Analysis status`は公開承認ステータスとは別に記録する。`Incomplete`の場合は、不足する証拠と確からしさを明示し、影響する結論・推奨事項を条件付きで記載する。判断を妨げる不足は`consulting-analyst`へ戻すか、この文書に残す。`Not performed`の場合は、分析未実施の範囲と理由を記載し、分析済みとして扱わない。
|
|
22
|
+
|
|
23
|
+
## 要旨
|
|
24
|
+
|
|
25
|
+
<問題、調査・分析の範囲、主要な発見、結論、読者への示唆を300〜500字で記載する。本文を読まなくても中心的な判断が分かるようにする。>
|
|
26
|
+
|
|
27
|
+
## 本書が答える問い
|
|
28
|
+
|
|
29
|
+
- 中心的な問い: <読者が判断したい問い>
|
|
30
|
+
- 中心的な主張: <証拠で支持または反証できる具体的な主張>
|
|
31
|
+
- 読者に求める次の行動: <検討、評価、実証、導入判断など>
|
|
32
|
+
|
|
33
|
+
## 対象範囲と用語
|
|
34
|
+
|
|
35
|
+
### 対象範囲
|
|
36
|
+
|
|
37
|
+
- 含む: <地域、業界、組織規模、技術、期間>
|
|
38
|
+
- 含まない: <対象外と、その理由>
|
|
39
|
+
- 情報の基準日: <YYYY-MM-DD>
|
|
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
|
+
<市場、制度、利用者、技術、運用などの変化を、出典付きの事実と分析者の解釈に分けて説明する。>
|
|
65
|
+
|
|
66
|
+
## 調査から得られた主要な発見
|
|
67
|
+
|
|
68
|
+
### <発見1を結論として表す見出し>
|
|
69
|
+
|
|
70
|
+
<発見を最初に記載し、その後に証拠、解釈、適用範囲を説明する。>
|
|
71
|
+
|
|
72
|
+
| 項目 | 内容 |
|
|
73
|
+
|---|---|
|
|
74
|
+
| 主張ID | CLM-001 |
|
|
75
|
+
| 主張 | <具体的な主張> |
|
|
76
|
+
| 関連仮説 HYP IDs | <関連HYP IDs、または理由付きN/A> |
|
|
77
|
+
| 分析上の発見 FND IDs | <関連FND IDs、または理由付きN/A> |
|
|
78
|
+
| 根拠 | EVD-001、EVD-002 |
|
|
79
|
+
| 確からしさ | High / Medium / Low |
|
|
80
|
+
| 適用範囲 | <どこまで当てはまるか> |
|
|
81
|
+
| 制約・反証 | <弱める条件、矛盾する証拠> |
|
|
82
|
+
|
|
83
|
+
### <発見2を結論として表す見出し>
|
|
84
|
+
|
|
85
|
+
<必要な数だけ同じ構造で記載する。>
|
|
86
|
+
|
|
87
|
+
## 選択肢と評価
|
|
88
|
+
|
|
89
|
+
| 選択肢 | 適する状況 | 期待効果 | 費用・負担 | リスク | 根拠 |
|
|
90
|
+
|---|---|---|---|---|---|
|
|
91
|
+
| 現状維持 | <状況> | <効果> | <負担> | <リスク> | <証拠ID> |
|
|
92
|
+
| <選択肢> | <状況> | <効果> | <負担> | <リスク> | <証拠ID> |
|
|
93
|
+
|
|
94
|
+
## 推奨する考え方またはソリューションパターン
|
|
95
|
+
|
|
96
|
+
<推奨事項を、適用条件とともに記載する。製品やサービスを例示する場合は、一般的な結論と製品固有の主張を分ける。>
|
|
97
|
+
|
|
98
|
+
```mermaid
|
|
99
|
+
flowchart LR
|
|
100
|
+
A[<課題・入力>] --> B[<推奨する能力・方式>]
|
|
101
|
+
B --> C[<期待する成果>]
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### 適用条件
|
|
105
|
+
|
|
106
|
+
- 適する条件: <条件>
|
|
107
|
+
- 適さない条件: <条件>
|
|
108
|
+
- 事前に検証する事項: <PoC・評価・法務確認など>
|
|
109
|
+
|
|
110
|
+
## 導入・適用時に検討する事項
|
|
111
|
+
|
|
112
|
+
| 観点 | 確認事項 | 判断材料 | 主なリスク |
|
|
113
|
+
|---|---|---|---|
|
|
114
|
+
| 組織・人材 | <確認事項> | <証拠・測定> | <リスク> |
|
|
115
|
+
| 業務・ガバナンス | <確認事項> | <証拠・測定> | <リスク> |
|
|
116
|
+
| データ・技術 | <確認事項> | <証拠・測定> | <リスク> |
|
|
117
|
+
| セキュリティ・法令 | <確認事項> | <証拠・測定> | <リスク> |
|
|
118
|
+
| 費用・運用 | <確認事項> | <証拠・測定> | <リスク> |
|
|
119
|
+
|
|
120
|
+
## 事例または検証結果
|
|
121
|
+
|
|
122
|
+
<事例、実証、シミュレーションのどれかを明示する。代表性を保証しない場合は、その制約を記載する。>
|
|
123
|
+
|
|
124
|
+
| 項目 | 内容 |
|
|
125
|
+
|---|---|
|
|
126
|
+
| 対象 | <組織・環境・条件> |
|
|
127
|
+
| 実施内容 | <方法> |
|
|
128
|
+
| 結果 | <測定値> |
|
|
129
|
+
| 比較基準 | <導入前・対照・目標> |
|
|
130
|
+
| 制約 | <一般化できない理由> |
|
|
131
|
+
| 出典 | <証拠ID・URL> |
|
|
132
|
+
| 顧客名・数値・事例の掲載許諾 | <許諾者・許諾日・条件、または匿名化の方法> |
|
|
133
|
+
|
|
134
|
+
## 反対意見・代替解釈・限界
|
|
135
|
+
|
|
136
|
+
- 反対意見: <有力な異論と、その根拠>
|
|
137
|
+
- 代替解釈: <同じ証拠から導ける別の結論>
|
|
138
|
+
- データの限界: <欠損、偏り、サンプル、期間>
|
|
139
|
+
- 将来変化する可能性: <技術、制度、市場など>
|
|
140
|
+
- 結論を見直す条件: <新しい証拠・閾値>
|
|
141
|
+
|
|
142
|
+
## 結論と次の判断
|
|
143
|
+
|
|
144
|
+
<中心的な問いへの回答を簡潔に示し、対象読者が次に行う評価・合意・実証・意思決定を記載する。新しい主張は追加しない。>
|
|
145
|
+
|
|
146
|
+
## 利害関係と開示
|
|
147
|
+
|
|
148
|
+
- 発行者と対象製品・サービスの関係: <関係・該当なし>
|
|
149
|
+
- 資金提供・協賛: <提供者・該当なし>
|
|
150
|
+
- 著者の利害関係: <内容・該当なし>
|
|
151
|
+
- データ提供者の関与: <収集、分析、レビューへの関与>
|
|
152
|
+
- AI利用: <調査・執筆・翻訳・校正での利用範囲>
|
|
153
|
+
|
|
154
|
+
## 証拠台帳
|
|
155
|
+
|
|
156
|
+
SRCは出典の記録、EVDは分析上の証拠の記録を表す。分析ハンドオフがある場合は、関連するHYP / FND / EVD IDsを主張・発見に紐付け、元のIDと意味を保持する。出典をEVDに置き換えない。該当しないリンクは理由付き`N/A`とし、ハンドオフがない場合はHYP / FND IDsを無理に作らない。
|
|
157
|
+
|
|
158
|
+
### 出典の記録
|
|
159
|
+
|
|
160
|
+
| 出典ID | 出典 | 種別 | 発行日 | 参照日 | 関連する証拠ID | 品質・制約 |
|
|
161
|
+
|---|---|---|---|---|---|---|
|
|
162
|
+
| SRC-001 | <著者、資料名、URL> | 一次 / 二次 | <YYYY-MM-DD> | <YYYY-MM-DD> | EVD-001 | <評価> |
|
|
163
|
+
|
|
164
|
+
### 分析上の証拠の記録
|
|
165
|
+
|
|
166
|
+
| 証拠ID | 出典ID | 記述の種別 | 証拠または解釈 | 関連仮説 HYP IDs | 関連発見 FND IDs | 関連主張 | 品質・制約 |
|
|
167
|
+
|---|---|---|---|---|---|---|---|
|
|
168
|
+
| EVD-001 | SRC-001 | Fact / Estimate / Interpretation | <証拠、または解釈とその根拠EVD IDs> | <関連HYP IDs、またはN/A> | <関連FND IDs、またはN/A> | CLM-001 | <評価> |
|
|
169
|
+
|
|
170
|
+
Interpretationは解釈として保持し、仮説を支持する証拠には数えない。`Supported`の仮説には、その仮説を支持するFact / EstimateのEVDが必要となる。
|
|
171
|
+
|
|
172
|
+
## 参考文献
|
|
173
|
+
|
|
174
|
+
1. <著者・組織>『<資料名>』<発行年>、<URL>(参照日: <YYYY-MM-DD>)
|
|
175
|
+
|
|
176
|
+
## 公開承認とレビュー記録
|
|
177
|
+
|
|
178
|
+
ステータスを`Approved for Publication`にするには、公開承認と、必須レビューの`Approved`または理由付き`N/A`が揃っていることを確認する。`Withdrawn`の場合は、撤回日と理由を記録する。
|
|
179
|
+
|
|
180
|
+
| 種別 | レビュー者・承認者 | 対象 | 判断 | 日付 | 条件・N/Aの理由 |
|
|
181
|
+
|---|---|---|---|---|---|
|
|
182
|
+
| 公開承認 | <氏名・役割・会議体> | 文書全体 | Approved / Rejected | <YYYY-MM-DD> | <条件> |
|
|
183
|
+
| 法務レビュー | <氏名・役割> | <対象箇所・文書全体> | Approved / Rejected / N/A | <YYYY-MM-DD> | <条件・N/Aの理由> |
|
|
184
|
+
| コンプライアンスレビュー | <氏名・役割> | <対象箇所・文書全体> | Approved / Rejected / N/A | <YYYY-MM-DD> | <条件・N/Aの理由> |
|
|
185
|
+
| 主張・数値検証 | <氏名・役割> | <CLM・EVD・事例ID> | Approved / Rejected / N/A | <YYYY-MM-DD> | <条件・N/Aの理由> |
|
|
186
|
+
| 顧客名・事例掲載許諾 | <許諾者・確認者> | <事例・顧客名・数値> | Approved / Rejected / N/A | <YYYY-MM-DD> | <条件・匿名化・N/Aの理由> |
|
|
187
|
+
|
|
188
|
+
## 変更履歴
|
|
189
|
+
|
|
190
|
+
| 版 | 日付 | 変更内容 | 変更者 | レビュー者 |
|
|
191
|
+
|---|---|---|---|---|
|
|
192
|
+
| 0.1 | <YYYY-MM-DD> | 初版 | <氏名> | <氏名> |
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# API reference type
|
|
2
|
+
|
|
3
|
+
The recommended skeleton and checklist for endpoint/function-level
|
|
4
|
+
reference documentation, optimized for a developer who wants to get a
|
|
5
|
+
first call working.
|
|
6
|
+
|
|
7
|
+
## Target reader
|
|
8
|
+
|
|
9
|
+
A developer who wants to call this API from their own code. The goal is
|
|
10
|
+
"get the smallest request to succeed".
|
|
11
|
+
|
|
12
|
+
## Recommended skeleton (per endpoint/function)
|
|
13
|
+
|
|
14
|
+
1. **Signature**: the endpoint (method + path) or function signature first.
|
|
15
|
+
2. **One-sentence description**: what it does. State side effects (state
|
|
16
|
+
changes, billing, async processing) if any.
|
|
17
|
+
3. **Parameters**: a table (name, type, required/optional, default,
|
|
18
|
+
description). Include units (seconds/ms, bytes/KB) in the description.
|
|
19
|
+
4. **Request example**: a minimal, runnable code example (curl or the
|
|
20
|
+
target language). Mark credentials clearly as placeholders.
|
|
21
|
+
5. **Response example**: a real success example (actual sample values, not
|
|
22
|
+
just types).
|
|
23
|
+
6. **Errors / status codes**: a table (code, meaning, whether to retry).
|
|
24
|
+
7. **Rate limits / deprecation notices** (if applicable): don't omit.
|
|
25
|
+
|
|
26
|
+
## Checklist
|
|
27
|
+
|
|
28
|
+
- [ ] Does the request example run after just swapping in values (URL/token
|
|
29
|
+
fields clearly marked as placeholders)?
|
|
30
|
+
- [ ] Does the parameter table have a required/optional column?
|
|
31
|
+
- [ ] Does each error code say what the client should do about it?
|
|
32
|
+
- [ ] Do deprecated parameters/endpoints point to a migration path?
|
|
33
|
+
- [ ] Are units (time, size, currency) stated explicitly?
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# Blueprint type
|
|
2
|
+
|
|
3
|
+
A Blueprint defines an agreed future state and the coordinated path from the
|
|
4
|
+
current state to that future state. It can cover technology, business
|
|
5
|
+
capabilities, operating models, governance, or a combination of them. It is
|
|
6
|
+
broader and more directional than a system design, but more executable than a
|
|
7
|
+
vision statement or strategy narrative.
|
|
8
|
+
|
|
9
|
+
## Target reader
|
|
10
|
+
|
|
11
|
+
Sponsors, architects, transformation leads, delivery owners, governance
|
|
12
|
+
bodies, and affected teams who must align on the destination, sequence,
|
|
13
|
+
decision rights, dependencies, and measures of progress.
|
|
14
|
+
|
|
15
|
+
## Settle before writing
|
|
16
|
+
|
|
17
|
+
- The outcome and planning horizon covered by the Blueprint
|
|
18
|
+
- The current-state baseline and evidence supporting it
|
|
19
|
+
- The target capabilities and principles that constrain the future state
|
|
20
|
+
- The dimensions in scope: business, organization, process, data, technology,
|
|
21
|
+
security, governance, or operations
|
|
22
|
+
- The authority that approves the Blueprint and owns subsequent changes
|
|
23
|
+
- The level of detail needed for funding, portfolio planning, or delivery
|
|
24
|
+
|
|
25
|
+
## Responsibility boundary
|
|
26
|
+
|
|
27
|
+
A Blueprint establishes direction, boundaries, target capabilities, major
|
|
28
|
+
building blocks, transformation workstreams, and sequencing. It does not
|
|
29
|
+
replace implementation-level system designs, detailed requirements, project
|
|
30
|
+
plans, operating procedures, or an investment approval proposal.
|
|
31
|
+
|
|
32
|
+
Use `system-design` when teams need buildable component, interface, data, and
|
|
33
|
+
deployment details. Use `technical-proposal` when the primary outcome is an
|
|
34
|
+
approval of one investment or approach. Use `blueprint` when multiple
|
|
35
|
+
initiatives or organizational and technical dimensions must converge on one
|
|
36
|
+
future state over time.
|
|
37
|
+
|
|
38
|
+
## Template
|
|
39
|
+
|
|
40
|
+
Start from `assets/templates/blueprint.md`.
|
|
41
|
+
The template is the Japanese-language skeleton; translate its headings when
|
|
42
|
+
the target document is English.
|
|
43
|
+
|
|
44
|
+
## Recommended skeleton
|
|
45
|
+
|
|
46
|
+
1. Intended outcome, planning horizon, scope, and authority
|
|
47
|
+
2. Drivers, principles, current-state baseline, and constraints
|
|
48
|
+
3. Target capabilities and future-state operating and technical views
|
|
49
|
+
4. Gap analysis, workstreams, dependencies, and transition states
|
|
50
|
+
5. Phased roadmap with entry, exit, and decision criteria
|
|
51
|
+
6. Governance, measures, risks, traceability, and change control
|
|
52
|
+
|
|
53
|
+
## Checklist
|
|
54
|
+
|
|
55
|
+
- [ ] Is the planning horizon and approval authority explicit?
|
|
56
|
+
- [ ] Is `Analysis status: Completed / Incomplete / Not performed` recorded
|
|
57
|
+
separately from approval status, with `Evidence gaps` and the analysis
|
|
58
|
+
handoff location (or none)?
|
|
59
|
+
- [ ] For `Incomplete`, are evidence gaps and confidence visible and every
|
|
60
|
+
affected conclusion or recommendation expressed with conditional wording,
|
|
61
|
+
or returned to consulting-analyst? For `Not performed`, are the scope and
|
|
62
|
+
reason explicit without implying completed analysis?
|
|
63
|
+
- [ ] Is the current state supported by evidence rather than assumption?
|
|
64
|
+
- [ ] Are target capabilities stated before products or implementation detail?
|
|
65
|
+
- [ ] Are business, process, data, technology, security, governance, and
|
|
66
|
+
operations dimensions included or explicitly marked out of scope?
|
|
67
|
+
- [ ] Does each gap map to a workstream, owner, dependency, and target state?
|
|
68
|
+
- [ ] Do roadmap phases have entry conditions, exit conditions, and measurable
|
|
69
|
+
outcomes rather than dates alone?
|
|
70
|
+
- [ ] Are transition states, coexistence, migration, and decommissioning
|
|
71
|
+
concerns visible?
|
|
72
|
+
- [ ] Are decision rights, exception handling, and change control defined?
|
|
73
|
+
- [ ] Can strategic drivers be traced through capabilities and workstreams to
|
|
74
|
+
measures?
|
|
75
|
+
- [ ] Does traceability preserve relevant Q / HYP / FND / EVD and GAP / INT / CRT
|
|
76
|
+
IDs from the consulting handoff alongside driver, principle, capability,
|
|
77
|
+
gap, workstream, and KPI IDs? Are inapplicable links marked `N/A` with a
|
|
78
|
+
reason without forcing consulting IDs when no consulting handoff exists?
|
|
79
|
+
- [ ] Are assumptions, risks, unresolved decisions, and superseded versions
|
|
80
|
+
recorded?
|
|
81
|
+
- [ ] Does the header status match the approval outcome?
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Code comments / docstrings type
|
|
2
|
+
|
|
3
|
+
The principles and checklist for in-code documentation, where the same
|
|
4
|
+
"why, not what" and completeness discipline applies at the scale of a
|
|
5
|
+
single comment or docstring.
|
|
6
|
+
|
|
7
|
+
## Target reader
|
|
8
|
+
|
|
9
|
+
Whoever changes this code next (including your future self). The goal is
|
|
10
|
+
to convey "why it's written this way" — the "what" should be conveyed by
|
|
11
|
+
the code itself.
|
|
12
|
+
|
|
13
|
+
## Principles
|
|
14
|
+
|
|
15
|
+
1. **Write "why", not "what"**: don't repeat in a comment what the code
|
|
16
|
+
already shows. Explain why this implementation/ordering/exception
|
|
17
|
+
handling is necessary.
|
|
18
|
+
2. **Write docstrings from the caller's perspective**: order arguments,
|
|
19
|
+
return values, exceptions, and side effects by what the *caller* wants
|
|
20
|
+
to know, not by internal implementation order.
|
|
21
|
+
3. **Give `TODO`/`FIXME` a reason and, if possible, an issue link**:
|
|
22
|
+
`TODO: fix later` carries zero information. Write
|
|
23
|
+
`TODO(#123): running synchronously, async pending queue rollout`
|
|
24
|
+
instead.
|
|
25
|
+
4. **Don't write comments that state the obvious**: delete comments like
|
|
26
|
+
`i += 1 # increment i by 1`.
|
|
27
|
+
5. **Only comment on non-obvious choices**: implementations that look like
|
|
28
|
+
a detour, special code for performance reasons, or external constraints
|
|
29
|
+
(API quirks, past-bug workarounds) must always get a comment.
|
|
30
|
+
|
|
31
|
+
## Checklist
|
|
32
|
+
|
|
33
|
+
- [ ] Are there redundant comments left where the code's intent is clear
|
|
34
|
+
even without them?
|
|
35
|
+
- [ ] Do non-obvious implementations have their reasoning explained?
|
|
36
|
+
- [ ] Is docstring argument order driven by the caller's concerns rather
|
|
37
|
+
than internal variable order?
|
|
38
|
+
- [ ] Do `TODO`/`FIXME` items have a reason or a tracking reference
|
|
39
|
+
(issue number, etc.)?
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Design doc / ADR / RFC type
|
|
2
|
+
|
|
3
|
+
The recommended skeleton and checklist for a design decision record: a
|
|
4
|
+
document meant to earn a reviewer's agreement now and explain the "why" to
|
|
5
|
+
someone reading it long after the decision was made.
|
|
6
|
+
|
|
7
|
+
## Target reader
|
|
8
|
+
|
|
9
|
+
Someone reviewing to reach a decision, or someone later tracing the history
|
|
10
|
+
of that decision. The goal is "consensus" or "record", not a how-to guide
|
|
11
|
+
for implementation.
|
|
12
|
+
|
|
13
|
+
## Recommended skeleton (ADR format)
|
|
14
|
+
|
|
15
|
+
1. **Title**: a noun phrase naming the decision (e.g. "Adopt Redis for the
|
|
16
|
+
async job queue").
|
|
17
|
+
2. **Status**: Proposed / Accepted / Rejected / Superseded — state one.
|
|
18
|
+
3. **Context**: why this decision is needed now. State the current
|
|
19
|
+
constraints as facts, separate from opinion.
|
|
20
|
+
4. **Decision**: say what was chosen in one sentence first, then the
|
|
21
|
+
details.
|
|
22
|
+
5. **Alternatives considered**: keep at least one, including why it was
|
|
23
|
+
rejected. Prevents future re-litigation of "why not A".
|
|
24
|
+
6. **Consequences**: not just the upside — include the costs/constraints
|
|
25
|
+
accepted.
|
|
26
|
+
7. **Open questions** (optional): leave unresolved points during review.
|
|
27
|
+
|
|
28
|
+
## Design doc (RFC format, pre-implementation) specifics
|
|
29
|
+
|
|
30
|
+
- Stating "what we will *not* build" (Non-Goals) before "what we will build"
|
|
31
|
+
keeps review discussion from drifting.
|
|
32
|
+
- If there are diagrams (sequence/architecture), make the diagram carry the
|
|
33
|
+
primary information; keep the prose as supporting detail only.
|
|
34
|
+
|
|
35
|
+
## Checklist
|
|
36
|
+
|
|
37
|
+
- [ ] Is the decision stated in one sentence up front?
|
|
38
|
+
- [ ] Are alternatives and their rejection reasons present (not written as
|
|
39
|
+
"the only option")?
|
|
40
|
+
- [ ] Are trade-offs (what's given up) stated explicitly?
|
|
41
|
+
- [ ] Are Non-Goals stated (for RFCs)?
|
|
42
|
+
- [ ] Does the status reflect the current state?
|