specdojo 0.2.0 → 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/agents/specdojo-orchestrator.md +165 -0
- package/CHANGELOG.md +280 -0
- package/README.md +143 -30
- package/dist/agent-response.js +20 -0
- package/dist/agent.js +4 -4
- package/dist/build-command.js +28 -8
- package/dist/dashboard.js +140 -9
- package/dist/devcontainer-command.js +43 -0
- package/dist/devcontainer-scaffold.js +165 -0
- package/dist/exec-agent-config.js +107 -9
- package/dist/exec-agent-git-state.js +18 -0
- package/dist/exec-agent-protected-config.js +46 -8
- package/dist/exec-evidence.js +254 -11
- package/dist/exec-format.js +13 -4
- package/dist/exec-handoff.js +336 -0
- package/dist/exec-parent-validation.js +317 -43
- package/dist/exec-pipeline-state.js +74 -9
- package/dist/exec-plans.js +115 -113
- package/dist/exec-protection-handoff.js +43 -2
- package/dist/exec-provider-scaffold.js +247 -15
- package/dist/exec-register-resume.js +65 -19
- package/dist/exec-register.js +9 -3
- package/dist/exec-repo-integration.js +811 -0
- package/dist/exec-repo-trace.js +182 -0
- package/dist/exec-reporter.js +613 -132
- package/dist/exec-results.js +81 -56
- package/dist/exec-run-lock.js +110 -107
- package/dist/exec-run.js +1585 -356
- package/dist/exec-shared.js +7 -0
- package/dist/exec-slot-lock.js +242 -0
- package/dist/exec-task-repos.js +415 -0
- package/dist/exec-trial.js +51 -25
- package/dist/exec-worktree-command.js +87 -43
- package/dist/exec-worktree-ops.js +502 -57
- package/dist/exec-worktree.js +114 -27
- package/dist/exec.js +13 -6
- package/dist/grade-result.js +128 -0
- package/dist/grade.js +809 -72
- package/dist/init-command.js +443 -0
- package/dist/job.js +160 -10
- package/dist/orchestrator.js +213 -0
- package/dist/package-paths.js +19 -1
- package/dist/register-event-merge.js +169 -0
- package/dist/register-item.js +7 -1
- package/dist/register.js +294 -86
- package/dist/review-grade.js +252 -0
- package/dist/review-plan.js +111 -1
- package/dist/review-types.js +40 -1
- package/dist/routine.js +72 -5
- package/dist/schedule-build.js +2 -2
- package/dist/schedule.js +17 -4
- package/dist/specdojo-config.js +466 -20
- package/dist/specdojo-gitignore.js +135 -0
- package/dist/specdojo.js +8 -1
- package/dist/viewpoint-document-kinds-check.js +128 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +348 -90
- package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +51 -17
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +7 -5
- package/docs/ja/specdojo/exec-templates/xrp-freeform-template.md +29 -31
- package/docs/ja/specdojo/exec-templates/xrp-fully-guided-template.md +34 -55
- package/docs/ja/specdojo/exec-templates/xrp-job-template.md +54 -0
- package/docs/ja/specdojo/exec-templates/xrp-recipe-guided-template.md +28 -37
- package/docs/ja/specdojo/exec-templates/xrp-recipe-maintenance-template.md +29 -34
- package/docs/ja/specdojo/exec-templates/xrp-retrofit-template.md +30 -30
- package/docs/ja/specdojo/exec-templates/xrp-rulebook-maintenance-template.md +29 -34
- package/docs/ja/specdojo/exec-templates/xrp-sample-maintenance-template.md +29 -34
- package/docs/ja/specdojo/exec-templates/xrp-template-maintenance-template.md +29 -34
- package/docs/ja/specdojo/exec-templates/xrp-template.md +29 -28
- package/docs/ja/specdojo/exec-templates/xrr-template.md +11 -9
- package/docs/ja/specdojo/guides/docs-editing-guide.md +20 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +103 -70
- package/docs/ja/specdojo/guides/exec-config-guide.md +91 -47
- package/docs/ja/specdojo/guides/exec-operation-guide.md +124 -27
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +40 -11
- package/docs/ja/specdojo/guides/kata-guide.md +4 -4
- package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +25 -4
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +1 -1
- package/docs/ja/specdojo/guides/practice-system-composition-guide.md +13 -13
- package/docs/ja/specdojo/guides/quick-start-guide.md +261 -32
- package/docs/ja/specdojo/guides/register-operation-guide.md +31 -14
- package/docs/ja/specdojo/guides/release-v0-3-0-migration-guide.md +264 -0
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +184 -0
- package/docs/ja/specdojo/guides/review-guide.md +195 -158
- package/docs/ja/specdojo/guides/routine-operation-guide.md +74 -9
- package/docs/ja/specdojo/guides/ryu-guide.md +32 -30
- package/docs/ja/specdojo/guides/schedule-design-guide.md +10 -10
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +1 -1
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +58 -33
- package/docs/ja/specdojo/guides/use-case-guide.md +3 -3
- package/docs/ja/specdojo/guides/waza-guide.md +15 -2
- package/docs/ja/specdojo/index.md +2 -2
- package/docs/ja/specdojo/philosophy/specdojo-philosophy.md +5 -5
- package/docs/ja/specdojo/recipes/bps-recipe.md +213 -0
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +52 -117
- package/docs/ja/specdojo/references/command-reference.md +336 -93
- package/docs/ja/specdojo/references/deliverables-reference.md +1 -1
- package/docs/ja/specdojo/references/directory-layout-reference.md +13 -9
- package/docs/ja/specdojo/references/specdojo-config-reference.md +107 -24
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +132 -220
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +6 -44
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +2 -0
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +0 -87
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +61 -39
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +0 -87
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +1 -33
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +0 -137
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +0 -247
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +0 -83
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +4 -2
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +78 -150
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +5 -4
- package/docs/ja/specdojo/rulebooks/sch-rulebook.md +1 -1
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +0 -11
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +0 -61
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +2 -47
- package/docs/ja/specdojo/samples/bps-sample.md +74 -21
- package/docs/ja/specdojo/samples/gl-sample.yaml +17 -1
- package/docs/ja/specdojo/samples/ifx-index-sample.yaml +28 -0
- package/docs/ja/specdojo/samples/pm-members-sample.yaml +2 -67
- package/docs/ja/specdojo/samples/pm-organization-sample.md +8 -7
- package/docs/ja/specdojo/samples/pm-raci-sample.md +1 -1
- package/docs/ja/specdojo/samples/tml-sample.yaml +40 -0
- package/docs/ja/specdojo/standards/document-metadata-standard.md +21 -16
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +14 -14
- package/docs/ja/specdojo/standards/job-definition-standard.md +37 -17
- package/docs/ja/specdojo/standards/people-and-organization-definition-standard.md +37 -32
- package/docs/ja/specdojo/standards/philosophy-authoring-standard.md +1 -1
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +21 -11
- package/docs/ja/specdojo/templates/agent-members-template.yaml +25 -0
- package/docs/ja/specdojo/templates/bps-template.md +91 -0
- package/docs/ja/specdojo/templates/pm-members-template.yaml +2 -59
- package/docs/specdojo/schemas/v1/agent-members.schema.yaml +76 -0
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +4 -2
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +55 -2
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +93 -6
- package/docs/specdojo/schemas/v1/exec-reporter-output.schema.yaml +27 -78
- package/docs/specdojo/schemas/v1/gl.schema.yaml +87 -0
- package/docs/specdojo/schemas/v1/grade-result.schema.yaml +33 -0
- package/docs/specdojo/schemas/v1/job-run.schema.yaml +27 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +25 -0
- package/docs/specdojo/schemas/v1/pipeline-state.schema.yaml +49 -1
- package/docs/specdojo/schemas/v1/pm-members.schema.yaml +9 -169
- package/docs/specdojo/schemas/v1/pm-review-viewpoints.schema.yaml +100 -10
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +13 -0
- package/docs/specdojo/schemas/v1/routine-run.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/routine.schema.yaml +7 -0
- package/docs/specdojo/schemas/v1/specdojo-config.schema.yaml +110 -0
- package/package.json +16 -9
- package/templates/antigravity/README.md +60 -0
- package/templates/antigravity/agent-members-snippet.yaml +61 -0
- package/templates/antigravity/exec-defaults-snippet.yaml +39 -0
- package/templates/antigravity/orchestrator.md +157 -0
- package/templates/antigravity/settings.global.json +55 -0
- package/templates/claude/agents/claude-executor.md +14 -0
- package/templates/claude/agents/claude-reporter.md +16 -0
- package/templates/claude/agents/specdojo-orchestrator.md +164 -0
- package/templates/claude/settings.edit.json +27 -1
- package/templates/codex/README.md +5 -4
- package/templates/codex/agents/specdojo-orchestrator.toml +165 -0
- package/templates/codex/orchestrator.md +157 -0
- package/templates/copilot/README.md +7 -5
- package/templates/copilot/{pm-members-snippet.yaml → agent-members-snippet.yaml} +4 -2
- package/templates/devcontainer/devcontainer.json +27 -0
- package/templates/devcontainer/emacs/init.el +88 -0
- package/templates/devcontainer/post-create.sh +62 -0
- package/templates/init-agent-members.yaml +200 -0
- package/templates/init-exec-defaults.yaml +72 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +204 -0
- package/docs/ja/specdojo/exec-templates/xrp-viewpoint-detail-template.md +0 -7
- package/docs/ja/specdojo/exec-templates/xrr-viewpoint-detail-template.md +0 -7
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
+
schema: docs/specdojo/schemas/v1/gl.schema.yaml
|
|
2
3
|
specdojo:
|
|
3
4
|
id: specdojo:gl-rulebook
|
|
4
5
|
type: rulebook
|
|
@@ -6,65 +7,68 @@ specdojo:
|
|
|
6
7
|
target_format: yaml
|
|
7
8
|
recipe: undecided
|
|
8
9
|
sample: specdojo:gl-sample
|
|
9
|
-
template:
|
|
10
|
+
template: not-needed
|
|
11
|
+
based_on:
|
|
12
|
+
- specdojo:rulebook-authoring-standard
|
|
10
13
|
---
|
|
11
14
|
|
|
12
15
|
# 用語集(Glossary)作成ルール
|
|
13
16
|
|
|
17
|
+
Glossary Documentation Rules
|
|
18
|
+
|
|
14
19
|
本ドキュメントは、業務分析・要求定義・設計・テストで参照する **用語集(Glossary)を YAML 形式で記述する標準ルール**です。
|
|
15
|
-
用語集は、プロジェクト内で同じ言葉を同じ意味で使うための「辞書」であり、業務データ辞書(BDD)などの `glossaryTermId` が参照する **用語ID(`tm-...`)の正(正式な参照先)**になります。
|
|
16
20
|
|
|
17
|
-
## 1.
|
|
21
|
+
## 1. 全体方針
|
|
18
22
|
|
|
19
|
-
|
|
23
|
+
- 用語集は YAML 形式で記述し、プロジェクト内で同じ言葉を同じ意味で使うための「辞書」として機能する。
|
|
24
|
+
- 業務データ辞書(BDD)やビジネスルール(BR)などで参照する用語は、先に用語集に登録して **用語ID(`tm-...`)を固定**し、用語集をその正式な参照先(正)とする。
|
|
25
|
+
- 用語は **業務用語(日本語)**で記述し、UI文言や内部コード名の辞書化は必要最小限にする。
|
|
26
|
+
- プロジェクト固有の用語集はプロジェクトごとに作成・保守し、実データは対象プロジェクトの文書内に記述する。
|
|
20
27
|
|
|
21
|
-
|
|
22
|
-
| ------ | ---------------------------------- | ---- |
|
|
23
|
-
| id | 用語集ID(`gl-...`) | 推奨 |
|
|
24
|
-
| title | 用語集名(例: 用語集: 在庫・調達) | 推奨 |
|
|
25
|
-
| locale | 言語(例: `ja` / `en`) | 推奨 |
|
|
26
|
-
| status | `draft`/`ready`/`deprecated` | 任意 |
|
|
27
|
-
| terms | 用語の配列 | ○ |
|
|
28
|
+
## 2. 位置づけと用語定義
|
|
28
29
|
|
|
29
|
-
|
|
30
|
+
- 本用語集(Glossary)は、プロジェクト全体の SSOT(Single Source of Truth)としての役割を持つ。
|
|
31
|
+
- 各種設計ドキュメントの `glossaryTermId` 等は、すべて本ルールで採番された `tm-...` ID を参照する。
|
|
32
|
+
|
|
33
|
+
## 3. ファイル命名・ID規則
|
|
34
|
+
|
|
35
|
+
### 3.1. ファイル命名
|
|
30
36
|
|
|
31
37
|
- ファイル名: `gl-<対象領域>-<locale>.yaml`
|
|
32
38
|
- 例: `gl-sales-ja.yaml`, `gl-inventory-ja.yaml`
|
|
33
|
-
-
|
|
39
|
+
- 多言語化する場合はファイルを分け、1 つのファイル内で言語を混在させない。
|
|
34
40
|
|
|
35
|
-
|
|
41
|
+
### 3.2. ID規約
|
|
36
42
|
|
|
37
|
-
-
|
|
38
|
-
-
|
|
39
|
-
- 用語の定義は「一文で意味が通り、境界が分かる」ように書きます(同義語の説明にならないように)。
|
|
40
|
-
- BDD や BR、BPS、BAC で参照する用語は、先に用語集に登録して **ID を固定**します。
|
|
43
|
+
- 用語集ID: `^gl-[a-z0-9-]+$` の形式とする。
|
|
44
|
+
- 用語ID: `^tm-[a-z0-9-]+$` の形式とする。
|
|
41
45
|
|
|
42
|
-
|
|
46
|
+
## 4. 推奨 Frontmatter 項目
|
|
43
47
|
|
|
44
|
-
|
|
45
|
-
- 用語ID: 正規表現 `^tm-[a-z0-9-]+$`
|
|
48
|
+
YAML ファイルの先頭に、以下のメタデータ(ルートキー)を持たせることを推奨する。
|
|
46
49
|
|
|
47
|
-
|
|
50
|
+
| 項目 | 説明 | 必須 |
|
|
51
|
+
| ------ | ---------------------------------- | ---- |
|
|
52
|
+
| id | 用語集ID(`gl-...`) | ○ |
|
|
53
|
+
| title | 用語集名(例: 用語集: 在庫・調達) | ○ |
|
|
54
|
+
| locale | 言語(例: `ja` / `en`) | ○ |
|
|
55
|
+
| status | `draft` / `ready` / `deprecated` | 任意 |
|
|
48
56
|
|
|
49
|
-
|
|
50
|
-
- 略語を使う場合は、業務用語集で一般的に通じるものに限定し、必要なら `definition` に補足。
|
|
57
|
+
## 5. 本文要件
|
|
51
58
|
|
|
52
|
-
|
|
59
|
+
### 5.1. ルートキー要件
|
|
53
60
|
|
|
54
|
-
-
|
|
55
|
-
- `definition` が曖昧(例: 「正しく処理される」「いい感じの在庫」など)
|
|
56
|
-
- 用語の説明に実装詳細(物理テーブル名、内部クラス名、SQL 等)を混ぜること
|
|
57
|
-
- 同じ概念を別名で重複登録し、`aliases` で統合しないこと
|
|
58
|
-
- ファイル内で言語を混在させること(多言語はファイル分割)
|
|
61
|
+
- メタデータに加え、トップレベルに `terms`(配列)を必ず持つ。
|
|
59
62
|
|
|
60
|
-
|
|
63
|
+
### 5.2. `terms` の項目
|
|
61
64
|
|
|
62
|
-
|
|
65
|
+
各用語の要素は以下のキーを持つ。
|
|
63
66
|
|
|
64
67
|
| 項目 | 説明 | 必須 |
|
|
65
68
|
| ------------ | --------------------------------------------------------- | ---- |
|
|
66
69
|
| id | 用語ID(`tm-...`) | ○ |
|
|
67
70
|
| term | 用語(正式名称) | ○ |
|
|
71
|
+
| englishName | 英語名(概念の英語表記) | 任意 |
|
|
68
72
|
| aliases | 別名(配列) | 任意 |
|
|
69
73
|
| definition | 定義(境界が分かる説明) | ○ |
|
|
70
74
|
| notes | 補足・運用メモ(前提、例外、使って良い文脈/ダメな文脈等) | 任意 |
|
|
@@ -74,13 +78,31 @@ specdojo:
|
|
|
74
78
|
| status | `official` / `deprecated` / `candidate` など | 任意 |
|
|
75
79
|
| example | 用例(短い例文) | 任意 |
|
|
76
80
|
|
|
77
|
-
|
|
81
|
+
## 6. 記述ガイド
|
|
82
|
+
|
|
83
|
+
### 6.1. IDの命名推奨
|
|
84
|
+
|
|
85
|
+
- `tm-` の命名は「名詞」を基本とする(例: `tm-reorder-point`)。
|
|
86
|
+
- 略語を使う場合は、業務用語集で一般的に通じるものに限定し、必要なら `definition` に補足する。
|
|
87
|
+
|
|
88
|
+
### 6.2. 定義の書き方
|
|
89
|
+
|
|
90
|
+
- 用語の定義は「一文で意味が通り、境界が分かる」ように書く。
|
|
91
|
+
- 単なる同義語の羅列にならないようにし、他と区別できる条件を明記する。
|
|
92
|
+
- 未確定事項や仮置き情報は、共通ラベル(`_TODO_` / `_UNDECIDED_` / `_ASSUMPTION_`)で記述する。
|
|
93
|
+
|
|
94
|
+
### 6.3. 関連用語と分類の運用
|
|
78
95
|
|
|
79
|
-
- `relatedTerms`
|
|
80
|
-
-
|
|
96
|
+
- `relatedTerms` および `category` は、**同じ用語集の中に存在する用語ID(`tm-...`)** を指定する。
|
|
97
|
+
- 関連が強い(同じ業務文脈でセットで出る)ものを中心にし、増やしすぎない。
|
|
98
|
+
- 用語の参照関係は `validate:schema` の一環として検証される。存在しない ID への参照や、用語 ID の重複がある場合は検証エラーとなる。
|
|
81
99
|
|
|
82
|
-
##
|
|
100
|
+
## 7. 禁止事項
|
|
83
101
|
|
|
84
|
-
-
|
|
85
|
-
- 用語ID
|
|
86
|
-
-
|
|
102
|
+
- 用語IDを未採番のままにすること、または重複させること。
|
|
103
|
+
- 用語IDを意味の違う用語に使い回すこと。
|
|
104
|
+
- `definition` を曖昧に書くこと(例: 「正しく処理される」「いい感じの在庫」など)。
|
|
105
|
+
- 用語の説明に実装詳細(物理テーブル名、内部クラス名、SQL 等)を混ぜること。
|
|
106
|
+
- 同じ概念を別名で重複登録し、`aliases` で統合しないこと。
|
|
107
|
+
- 1 つのファイル内で言語を混在させること。
|
|
108
|
+
- 章番号なし見出しを使用したり、章番号末尾の `.` を省略したりすること。
|
|
@@ -124,90 +124,3 @@ YAML の先頭に次のメタ項目を置きます。
|
|
|
124
124
|
- 標準出力と標準エラーを混同したり、出力形式を「CLI の既定」とだけ記載したり、終了コードの意味を定義せずに成否判定を文言解析に依存しない。
|
|
125
125
|
- 副作用があるコマンドを冪等性条件なしで自動再試行対象にしない。認証失敗、認可失敗、入力不正を一時失敗として扱わない。
|
|
126
126
|
- DB 物理構造、内部クラス名、プロセス起動ライブラリの API 呼び出し、スクリプト全文などの実装詳細を含めない。
|
|
127
|
-
|
|
128
|
-
## 8. サンプル
|
|
129
|
-
|
|
130
|
-
```yaml
|
|
131
|
-
id: ifx-cmd-supplier-order
|
|
132
|
-
type: command
|
|
133
|
-
title: 仕入先への発注登録コマンド連携仕様
|
|
134
|
-
status: draft
|
|
135
|
-
rulebook: specdojo:ifx-cmd-rulebook
|
|
136
|
-
version: 1
|
|
137
|
-
|
|
138
|
-
command:
|
|
139
|
-
executable: supplier-cli
|
|
140
|
-
subcommands: [orders, submit]
|
|
141
|
-
purpose: 確定した発注データを仕入先サービスへ登録する
|
|
142
|
-
version_constraint: ">=2.1.0 <3.0.0"
|
|
143
|
-
shell: false
|
|
144
|
-
|
|
145
|
-
arguments:
|
|
146
|
-
- name: --file
|
|
147
|
-
kind: option
|
|
148
|
-
required: true
|
|
149
|
-
value_type: path
|
|
150
|
-
value_source: generated
|
|
151
|
-
description: 発注データ JSON のパス
|
|
152
|
-
example: tmp/orders/ORD-0001.json
|
|
153
|
-
- name: --request-id
|
|
154
|
-
kind: option
|
|
155
|
-
required: true
|
|
156
|
-
value_type: string
|
|
157
|
-
value_source: generated
|
|
158
|
-
description: 重複登録を防ぐリクエスト ID
|
|
159
|
-
example: req-order-0001
|
|
160
|
-
|
|
161
|
-
streams:
|
|
162
|
-
stdin:
|
|
163
|
-
mode: none
|
|
164
|
-
format: none
|
|
165
|
-
stdout:
|
|
166
|
-
format: json
|
|
167
|
-
encoding: UTF-8
|
|
168
|
-
description: order_id と accepted_at を含む登録結果
|
|
169
|
-
stderr:
|
|
170
|
-
format: text
|
|
171
|
-
encoding: UTF-8
|
|
172
|
-
description: 診断情報。認証情報は出力しない
|
|
173
|
-
|
|
174
|
-
exit_codes:
|
|
175
|
-
- code: 0
|
|
176
|
-
meaning: 発注を登録した、または同じ request_id の登録済み結果を返した
|
|
177
|
-
category: success
|
|
178
|
-
retryable: false
|
|
179
|
-
- code: 2
|
|
180
|
-
meaning: 引数または発注データが不正
|
|
181
|
-
category: input_error
|
|
182
|
-
retryable: false
|
|
183
|
-
- code: 75
|
|
184
|
-
meaning: 仕入先サービスが一時的に利用できない
|
|
185
|
-
category: transient_failure
|
|
186
|
-
retryable: true
|
|
187
|
-
|
|
188
|
-
authentication:
|
|
189
|
-
method: api_token
|
|
190
|
-
injection:
|
|
191
|
-
mechanism: environment_variable
|
|
192
|
-
names: [SUPPLIER_CLI_TOKEN]
|
|
193
|
-
secret_source: 実行環境のシークレットストア
|
|
194
|
-
log_policy: 環境変数の値をコマンド表示、stdout、stderr、エラー記録に出力しない
|
|
195
|
-
|
|
196
|
-
execution:
|
|
197
|
-
working_directory: repository_root
|
|
198
|
-
timeout_seconds: 60
|
|
199
|
-
network_required: true
|
|
200
|
-
max_parallel: 1
|
|
201
|
-
idempotency:
|
|
202
|
-
guaranteed: true
|
|
203
|
-
condition: 同じ --request-id を再送する
|
|
204
|
-
|
|
205
|
-
error_handling:
|
|
206
|
-
retry:
|
|
207
|
-
on_categories: [transient_failure]
|
|
208
|
-
max_attempts: 3
|
|
209
|
-
backoff: exponential
|
|
210
|
-
timeout_action: 子プロセスを終了し、不完全な stdout を破棄する
|
|
211
|
-
malformed_output_action: 再試行せず、出力解析失敗として停止する
|
|
212
|
-
authentication_failure_action: 再試行せず、認証状態の確認を依頼する
|
|
213
|
-
```
|
|
@@ -5,7 +5,7 @@ specdojo:
|
|
|
5
5
|
status: draft
|
|
6
6
|
target_format: yaml
|
|
7
7
|
recipe: not-needed
|
|
8
|
-
sample:
|
|
8
|
+
sample: specdojo:ifx-index-sample
|
|
9
9
|
template: not-needed
|
|
10
10
|
---
|
|
11
11
|
|
|
@@ -60,35 +60,3 @@ ESIL は「どの外部システムと」「何を」「どの方向で」「ど
|
|
|
60
60
|
| timing | 連携タイミング(例: 発注確定時、日次集計後) | ○ |
|
|
61
61
|
| error_handling | エラー処理・備考(簡潔に) | 任意 |
|
|
62
62
|
| spec_ref | 詳細仕様ID(`ifx-api-...` / `ifx-file-...` / `ifx-msg-...` / `ifx-cmd-...`)または `TBD` | 任意 |
|
|
63
|
-
|
|
64
|
-
## 5. サンプル(YAML)
|
|
65
|
-
|
|
66
|
-
```yaml
|
|
67
|
-
id: ifx-main
|
|
68
|
-
type: api
|
|
69
|
-
title: 外部システムIF一覧(main)
|
|
70
|
-
status: draft
|
|
71
|
-
supersedes: []
|
|
72
|
-
|
|
73
|
-
interfaces:
|
|
74
|
-
- name: 発注データ送信
|
|
75
|
-
source: 受発注管理(コンテナ)
|
|
76
|
-
target: 仕入先システム
|
|
77
|
-
direction: source_to_target
|
|
78
|
-
kind: ファイル
|
|
79
|
-
format: CSV
|
|
80
|
-
timing: 発注確定時
|
|
81
|
-
error_handling: 異常時は再送・管理者通知
|
|
82
|
-
|
|
83
|
-
spec_ref: ifx-file-orders
|
|
84
|
-
|
|
85
|
-
- name: 決済依頼/結果
|
|
86
|
-
source: 決済(コンテナ)
|
|
87
|
-
target: 決済サービス
|
|
88
|
-
direction: bidirectional
|
|
89
|
-
kind: API
|
|
90
|
-
format: JSON
|
|
91
|
-
timing: 決済時
|
|
92
|
-
error_handling: 失敗時はリトライ/保留
|
|
93
|
-
spec_ref: ifx-api-payment
|
|
94
|
-
```
|
|
@@ -218,140 +218,3 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
218
218
|
| バックアップ/リストア方針に RTO/RPO 観点を含めない | 復旧計画の実効性が担保できないため |
|
|
219
219
|
| 関連ドキュメント導線(`opr` 等)を省略する | 参照先が分散し、運用時に判断を誤るため |
|
|
220
220
|
| 手順(コマンド/チェックリスト)を OPD に大量記載する | OPR と二重管理になり、更新不整合を起こすため |
|
|
221
|
-
|
|
222
|
-
## 8. サンプル(抜粋例)
|
|
223
|
-
|
|
224
|
-
注:以下はルール文書内の例示です。生成する `opd-index` / `opd-<term>` では `## 1...` から始まります。
|
|
225
|
-
|
|
226
|
-
### 8.1. サンプル: opd-index(全体)
|
|
227
|
-
|
|
228
|
-
```yaml
|
|
229
|
-
---
|
|
230
|
-
id: opd-index
|
|
231
|
-
type: operations
|
|
232
|
-
title: 運用方針・設計: 全体
|
|
233
|
-
status: draft
|
|
234
|
-
based_on: []
|
|
235
|
-
supersedes: []
|
|
236
|
-
---
|
|
237
|
-
```
|
|
238
|
-
|
|
239
|
-
#### 8.1.1. 概要(index)
|
|
240
|
-
|
|
241
|
-
恒常運用の品質基準と統制方針を定義し、運用判断の基準を一元化する(本書がSSOT)。
|
|
242
|
-
|
|
243
|
-
#### 8.1.2. SLO・SLA・KPI
|
|
244
|
-
|
|
245
|
-
| 指標 | 目標値 | 測定期間 | 測定方法 | 証跡 | 判定者 |
|
|
246
|
-
| ----------- | ------------ | -------- | ------------------------ | ------------ | -------------- |
|
|
247
|
-
| 可用性 | 99.9%以上 | 月次 | 監視SaaSの稼働率集計 | 監視レポート | 運用責任者 |
|
|
248
|
-
| API応答時間 | p95 < 300ms | 週次 | APMのp95集計 | APMレポート | 運用責任者 |
|
|
249
|
-
| 一次応答 | P1: 30分以内 | 月次 | チケット初回応答時刻集計 | 問合せ台帳 | サポート責任者 |
|
|
250
|
-
|
|
251
|
-
#### 8.1.3. 体制・責任分界(RACI・当番・エスカレーション)
|
|
252
|
-
|
|
253
|
-
| 対象 | R(実行) | A(責任) | C(相談) | I(共有) | 備考 |
|
|
254
|
-
| ------------- | --------- | --------- | --------- | --------- | -------------- |
|
|
255
|
-
| 監視/一次対応 | Ops | Ops Lead | Dev Lead | PO | P1は即時連絡 |
|
|
256
|
-
| 障害復旧 | Ops | Ops Lead | Dev | Biz/PO | 復旧後に報告 |
|
|
257
|
-
| 仕様判断 | Biz | PO | Ops/Dev | - | 停止判断を含む |
|
|
258
|
-
|
|
259
|
-
#### 8.1.4. 関連ドキュメント導線(`opr` 等)
|
|
260
|
-
|
|
261
|
-
| 種別 | ドキュメントID | 目的 | 備考 |
|
|
262
|
-
| ---- | -------------- | ------------------------ | ---------- |
|
|
263
|
-
| 手順 | opr-index | 運用手順の全体構成 | 必須 |
|
|
264
|
-
| 手順 | opr-incident | 障害一次対応/復旧手順 | 該当時 |
|
|
265
|
-
| 移行 | otp-index | ハイパーケア体制(参考) | 必要時のみ |
|
|
266
|
-
|
|
267
|
-
### 8.2. サンプル: opd-monitoring(監視の term)
|
|
268
|
-
|
|
269
|
-
```yaml
|
|
270
|
-
---
|
|
271
|
-
id: opd-monitoring
|
|
272
|
-
type: operations
|
|
273
|
-
title: 運用方針・設計: 監視
|
|
274
|
-
status: draft
|
|
275
|
-
based_on: []
|
|
276
|
-
supersedes: []
|
|
277
|
-
---
|
|
278
|
-
```
|
|
279
|
-
|
|
280
|
-
#### 8.2.1. 概要(monitoring)
|
|
281
|
-
|
|
282
|
-
監視・アラートの方針を `opd-index` の差分として定義する(指標・閾値・通知先・初動の具体化)。
|
|
283
|
-
|
|
284
|
-
#### 8.2.2. 監視・アラート方針(指標・閾値・通知先・初動)
|
|
285
|
-
|
|
286
|
-
| 監視対象 | 指標/閾値 | 通知先 | 初動(誰が何をするか) | 備考 |
|
|
287
|
-
| -------- | --------------------- | ------ | -------------------------------------------- | ---------------- |
|
|
288
|
-
| API | 5xx率 > 1%(5分) | #ops | Ops当番がダッシュボード確認→切り分け開始 | 誤検知は閾値調整 |
|
|
289
|
-
| DB | レプリカ遅延 > 30s | #ops | Ops当番が負荷/ジョブ確認→Devへ連絡(P2以上) | |
|
|
290
|
-
| Batch | 予定時刻+15分で未完了 | #ops | Ops当番がジョブ状態確認→再実行可否を判断 | 詳細は opr-batch |
|
|
291
|
-
|
|
292
|
-
#### 8.2.3. 関連ドキュメント導線(`opr` 等)
|
|
293
|
-
|
|
294
|
-
| 種別 | ドキュメントID | 目的 | 備考 |
|
|
295
|
-
| ---- | -------------- | ------------------------ | ------ |
|
|
296
|
-
| 手順 | opr-monitoring | アラート対応の手順・証跡 | 必須 |
|
|
297
|
-
| 手順 | opr-batch | バッチ失敗時の再実行手順 | 該当時 |
|
|
298
|
-
|
|
299
|
-
### 8.3. サンプル: opd-incident-management(障害対応の term)
|
|
300
|
-
|
|
301
|
-
```yaml
|
|
302
|
-
---
|
|
303
|
-
id: opd-incident-management
|
|
304
|
-
type: operations
|
|
305
|
-
title: 運用方針・設計: 障害対応
|
|
306
|
-
status: draft
|
|
307
|
-
based_on: []
|
|
308
|
-
supersedes: []
|
|
309
|
-
---
|
|
310
|
-
```
|
|
311
|
-
|
|
312
|
-
#### 8.3.1. 概要(incident-management)
|
|
313
|
-
|
|
314
|
-
障害対応の優先度、停止判断、周知方針を `opd-index` の差分として具体化する。
|
|
315
|
-
|
|
316
|
-
#### 8.3.2. 障害対応方針(優先度・停止判断・周知)
|
|
317
|
-
|
|
318
|
-
| 優先度 | 例 | 目標(一次応答/復旧) | 停止判断 | 周知 |
|
|
319
|
-
| ------ | --------------------- | --------------------- | ----------------------------- | ----------------------------- |
|
|
320
|
-
| P1 | 全ユーザ影響/決済不可 | 30分/4h | Ops Leadが即時→PO承認で停止可 | 全ユーザ(ステータス/メール) |
|
|
321
|
-
| P2 | 一部機能停止 | 2h/1d | Ops Lead判断、POへ共有 | 影響範囲のみ |
|
|
322
|
-
| P3 | 軽微/回避あり | 1d/次リリース | 停止しない | 原則なし |
|
|
323
|
-
|
|
324
|
-
#### 8.3.3. 関連ドキュメント導線(`opr` 等)
|
|
325
|
-
|
|
326
|
-
| 種別 | ドキュメントID | 目的 | 備考 |
|
|
327
|
-
| ---- | -------------- | ---------------------------- | ---- |
|
|
328
|
-
| 手順 | opr-incident | 障害切り分け/復旧/報告の手順 | 必須 |
|
|
329
|
-
|
|
330
|
-
### 8.4. サンプル: opd-access-control(権限運用の term)
|
|
331
|
-
|
|
332
|
-
```yaml
|
|
333
|
-
---
|
|
334
|
-
id: opd-access-control
|
|
335
|
-
type: operations
|
|
336
|
-
title: 運用方針・設計: 権限・アカウント
|
|
337
|
-
status: draft
|
|
338
|
-
based_on: []
|
|
339
|
-
supersedes: []
|
|
340
|
-
---
|
|
341
|
-
```
|
|
342
|
-
|
|
343
|
-
#### 8.4.1. 概要(access-control)
|
|
344
|
-
|
|
345
|
-
権限付与/剥奪、棚卸し、監査ログ、緊急権限を `opd-index` の差分として定義する。
|
|
346
|
-
|
|
347
|
-
#### 8.4.2. 権限・アカウント運用(棚卸し・監査ログ)
|
|
348
|
-
|
|
349
|
-
- 付与/剥奪はチケット起票を必須とし、承認者はOps Leadとする
|
|
350
|
-
- 棚卸しは月次で実施し、結果は監査ログ保管領域に保存する
|
|
351
|
-
- ブレークグラスは2名承認 + 24時間で自動失効(原則)
|
|
352
|
-
|
|
353
|
-
#### 8.4.3. 関連ドキュメント導線(`opr` 等)
|
|
354
|
-
|
|
355
|
-
| 種別 | ドキュメントID | 目的 | 備考 |
|
|
356
|
-
| ---- | ------------------ | ------------------------------ | ---- |
|
|
357
|
-
| 手順 | opr-access-control | アカウント付与/剥奪/棚卸し手順 | 必須 |
|
|
@@ -235,250 +235,3 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
235
235
|
| バックアップ確認・リストア演習を手順化しない | 復旧可能性が検証できないため |
|
|
236
236
|
| OPD と矛盾する運用手順を独自定義する | 方針と手順の整合が崩れ、運用品質を損なうため |
|
|
237
237
|
| 長大なコマンド列や設定全文を本文に貼り付ける | 差分管理が破綻するため(別紙/リンクに寄せる) |
|
|
238
|
-
|
|
239
|
-
## 8. サンプル(拡充)
|
|
240
|
-
|
|
241
|
-
注:以下はルール文書内の例示です。生成する `opr-index` / `opr-<term>` では `## 1...` から始まります。
|
|
242
|
-
|
|
243
|
-
### 8.1. サンプル: opr-index(全体)
|
|
244
|
-
|
|
245
|
-
```yaml
|
|
246
|
-
---
|
|
247
|
-
id: opr-index
|
|
248
|
-
type: operations
|
|
249
|
-
title: 運用手順: 全体
|
|
250
|
-
status: draft
|
|
251
|
-
based_on: []
|
|
252
|
-
supersedes: []
|
|
253
|
-
---
|
|
254
|
-
```
|
|
255
|
-
|
|
256
|
-
#### 8.1.1. ## 1. 概要(index)
|
|
257
|
-
|
|
258
|
-
恒常運用の実行手順を標準化し、担当者差によらず同一品質で運用できる状態を定義する(本書がSSOT)。
|
|
259
|
-
|
|
260
|
-
#### 8.1.2. ## 3. 日次/週次/月次点検手順
|
|
261
|
-
|
|
262
|
-
| 頻度 | 手順 | 実施者 | 完了条件 | 証跡 |
|
|
263
|
-
| ---- | ---- | ------ | -------- | ---- |
|
|
264
|
-
|
|
265
|
-
| 日次 | 監視ダッシュ確認 | Ops当番 | P1相当の異常がない、または起票済み | 日次チェックシート |
|
|
266
|
-
| 週次 | 主要アラートの誤検知レビュー | Ops Lead | 誤検知が棚卸し済み | 週次レビュー記録 |
|
|
267
|
-
| 月次 | 権限棚卸しの実施確認 | Sec/Ops | 棚卸し完了 | 棚卸しレポート |
|
|
268
|
-
|
|
269
|
-
#### 8.1.3. ## 11. 証跡(ログ、チケット、チェックリスト、実施記録)
|
|
270
|
-
|
|
271
|
-
| 証跡種別 | 保存先 | 保管期間 | 参照権限 | 最低限残す識別子 |
|
|
272
|
-
| -------------- | --------- | -------- | -------- | ---------------- |
|
|
273
|
-
| チケット | Issue管理 | 2年 | Ops/Dev | ticket_id |
|
|
274
|
-
| 実施ログ | ログ基盤 | 90日 | Ops | run_id, job_id |
|
|
275
|
-
| チェックリスト | Docs | 1年 | Ops | 実施日, 実施者 |
|
|
276
|
-
|
|
277
|
-
#### 8.1.4. ## 12. 関連ドキュメント導線(`opd` 参照、`mip` / `otp` / `cop` 連携)
|
|
278
|
-
|
|
279
|
-
| 種別 | ドキュメントID | 目的 | 備考 |
|
|
280
|
-
| ---- | ------------------ | ------------------------------------- | ---------- |
|
|
281
|
-
| 方針 | opd-index | 統制・判断基準(SLO/SLA、停止判断等) | 必須 |
|
|
282
|
-
| 手順 | opr-incident | 障害対応手順(優先度別) | 該当時 |
|
|
283
|
-
| 手順 | opr-monitoring | アラート対応手順 | 該当時 |
|
|
284
|
-
| 手順 | opr-backup-restore | バックアップ確認/復旧演習 | 該当時 |
|
|
285
|
-
| 移行 | otp-index | ハイパーケア連携(参考) | 必要時のみ |
|
|
286
|
-
|
|
287
|
-
---
|
|
288
|
-
|
|
289
|
-
### 8.2. サンプル: opr-incident(障害対応)
|
|
290
|
-
|
|
291
|
-
```yaml
|
|
292
|
-
---
|
|
293
|
-
id: opr-incident
|
|
294
|
-
type: operations
|
|
295
|
-
title: 運用手順: 障害対応
|
|
296
|
-
status: draft
|
|
297
|
-
based_on: [opd-incident-management]
|
|
298
|
-
supersedes: []
|
|
299
|
-
---
|
|
300
|
-
```
|
|
301
|
-
|
|
302
|
-
#### 8.2.1. 概要(incident)
|
|
303
|
-
|
|
304
|
-
障害対応の切り分け・一次対応・復旧・報告を `opr-index` の具体手順として定義する。
|
|
305
|
-
|
|
306
|
-
#### 8.2.2. 障害対応手順(P1/P2…、切り分け、一次対応、復旧)
|
|
307
|
-
|
|
308
|
-
| 優先度 | 初動SLA | 切り分け | 一次対応 | 復旧 | エスカレーション |
|
|
309
|
-
| ------ | ------- | -------------------------- | ------------------------- | -------------------- | ----------------------- |
|
|
310
|
-
| P1 | 30分 | 監視→直近変更→主要依存確認 | 影響遮断(機能停止/迂回) | 復旧作業→確認 | Ops Lead→PO(停止判断) |
|
|
311
|
-
| P2 | 2時間 | ログ/メトリクス確認 | 回避策提示 | 恒久対応チケット起票 | Ops Lead→Dev Lead |
|
|
312
|
-
| P3 | 1営業日 | 再現条件整理 | 影響が小さければ保留 | 次リリースで対応 | Ops Leadへ共有 |
|
|
313
|
-
|
|
314
|
-
#### 8.2.3. 証跡(ログ、チケット、チェックリスト、実施記録)
|
|
315
|
-
|
|
316
|
-
- 必須: ticket_id、影響範囲、発生/検知時刻、一次対応内容、復旧時刻、原因、再発防止
|
|
317
|
-
- 保存先: 障害チケット(template: INC-01)
|
|
318
|
-
|
|
319
|
-
#### 8.2.4. 関連ドキュメント導線
|
|
320
|
-
|
|
321
|
-
| 種別 | ドキュメントID | 目的 | 備考 |
|
|
322
|
-
| ---- | ----------------------- | ------------------------ | ------ |
|
|
323
|
-
| 方針 | opd-incident-management | 優先度/停止判断/周知基準 | 必須 |
|
|
324
|
-
| 手順 | opr-monitoring | アラート起点の切り分け | 該当時 |
|
|
325
|
-
|
|
326
|
-
---
|
|
327
|
-
|
|
328
|
-
### 8.3. サンプル: opr-monitoring(アラート対応)
|
|
329
|
-
|
|
330
|
-
```yaml
|
|
331
|
-
---
|
|
332
|
-
id: opr-monitoring
|
|
333
|
-
type: operations
|
|
334
|
-
title: 運用手順: 監視・アラート対応
|
|
335
|
-
status: draft
|
|
336
|
-
based_on: [opd-monitoring]
|
|
337
|
-
supersedes: []
|
|
338
|
-
---
|
|
339
|
-
```
|
|
340
|
-
|
|
341
|
-
#### 8.3.1. 概要(monitoring)
|
|
342
|
-
|
|
343
|
-
監視アラートの確認→暫定対応→恒久対応を `opr-index` の具体手順として定義する。
|
|
344
|
-
|
|
345
|
-
#### 8.3.2. アラート対応手順(確認→暫定対応→恒久対応)
|
|
346
|
-
|
|
347
|
-
| 段階 | 手順 | 完了条件 | 証跡 |
|
|
348
|
-
| -------- | -------------------------------- | ---------------------- | ------------ |
|
|
349
|
-
| 確認 | アラート種別/影響/発生範囲を確認 | 優先度(P1/P2/P3)確定 | チケット起票 |
|
|
350
|
-
| 暫定対応 | 影響遮断(機能停止/スロットル) | 影響拡大が止まる | 実施ログ |
|
|
351
|
-
| 恒久対応 | 原因特定→修正計画→反映 | 再発防止策が合意 | 修正チケット |
|
|
352
|
-
| 誤検知 | 根拠を記録し閾値/抑止を提案 | 再発防止(閾値調整) | 設定変更記録 |
|
|
353
|
-
|
|
354
|
-
---
|
|
355
|
-
|
|
356
|
-
### 8.4. サンプル: opr-backup-restore(バックアップ/復旧演習)
|
|
357
|
-
|
|
358
|
-
```yaml
|
|
359
|
-
---
|
|
360
|
-
id: opr-backup-restore
|
|
361
|
-
type: operations
|
|
362
|
-
title: 運用手順: バックアップ確認・リストア
|
|
363
|
-
status: draft
|
|
364
|
-
based_on: [opd-index]
|
|
365
|
-
supersedes: []
|
|
366
|
-
---
|
|
367
|
-
```
|
|
368
|
-
|
|
369
|
-
#### 8.4.1. バックアップ確認・リストア手順(演習含む)
|
|
370
|
-
|
|
371
|
-
- 確認(毎日):
|
|
372
|
-
- 最新バックアップの生成時刻とサイズを確認
|
|
373
|
-
- 失敗があればチケット起票(P2)
|
|
374
|
-
|
|
375
|
-
- 演習(四半期):
|
|
376
|
-
- staging にリストア → 主要テーブルの件数/参照整合を確認
|
|
377
|
-
- 所要時間を記録し、RTO/RPO達成可否を判定する
|
|
378
|
-
|
|
379
|
-
証跡:
|
|
380
|
-
|
|
381
|
-
- 演習レポート(日時/所要時間/成功可否/ログURL)
|
|
382
|
-
|
|
383
|
-
---
|
|
384
|
-
|
|
385
|
-
### 8.5. サンプル: opr-batch(バッチ再実行)
|
|
386
|
-
|
|
387
|
-
```yaml
|
|
388
|
-
---
|
|
389
|
-
id: opr-batch
|
|
390
|
-
type: operations
|
|
391
|
-
title: 運用手順: バッチ再実行・失敗対応
|
|
392
|
-
status: draft
|
|
393
|
-
based_on: [opd-index]
|
|
394
|
-
supersedes: []
|
|
395
|
-
---
|
|
396
|
-
```
|
|
397
|
-
|
|
398
|
-
#### 8.5.1. バッチ再実行・失敗時対応
|
|
399
|
-
|
|
400
|
-
- 失敗検知: 監視アラート or ジョブ管理の失敗通知
|
|
401
|
-
- 再実行条件:
|
|
402
|
-
- 同一run_idで再実行可否を確認(冪等性方式に従う)
|
|
403
|
-
- 再実行上限: 1回(2回目はOps Lead判断)
|
|
404
|
-
|
|
405
|
-
- エスカレーション:
|
|
406
|
-
- データ不整合の可能性がある場合は P1 として `opr-incident` に切替
|
|
407
|
-
|
|
408
|
-
---
|
|
409
|
-
|
|
410
|
-
### 8.6. サンプル: opr-change(運用変更)
|
|
411
|
-
|
|
412
|
-
```yaml
|
|
413
|
-
---
|
|
414
|
-
id: opr-change
|
|
415
|
-
type: operations
|
|
416
|
-
title: 運用手順: 運用変更(設定変更・デプロイ)
|
|
417
|
-
status: draft
|
|
418
|
-
based_on: [opd-index]
|
|
419
|
-
supersedes: []
|
|
420
|
-
---
|
|
421
|
-
```
|
|
422
|
-
|
|
423
|
-
#### 8.6.1. 運用変更作業(設定変更・デプロイ・ロールバック)
|
|
424
|
-
|
|
425
|
-
- 事前:
|
|
426
|
-
- 変更チケット起票(承認者: Ops Lead)
|
|
427
|
-
- 影響評価とロールバック方針を記載
|
|
428
|
-
|
|
429
|
-
- 実施:
|
|
430
|
-
- 実施ログ(誰が/いつ/何を)を残す
|
|
431
|
-
|
|
432
|
-
- ロールバック:
|
|
433
|
-
- 異常(P1/P2)発生時は即時戻し、報告
|
|
434
|
-
|
|
435
|
-
---
|
|
436
|
-
|
|
437
|
-
### 8.7. サンプル: opr-access-control(アカウント付与/剥奪)
|
|
438
|
-
|
|
439
|
-
```yaml
|
|
440
|
-
---
|
|
441
|
-
id: opr-access-control
|
|
442
|
-
type: operations
|
|
443
|
-
title: 運用手順: アカウント付与・剥奪
|
|
444
|
-
status: draft
|
|
445
|
-
based_on: [opd-access-control]
|
|
446
|
-
supersedes: []
|
|
447
|
-
---
|
|
448
|
-
```
|
|
449
|
-
|
|
450
|
-
#### 8.7.1. アカウント付与/剥奪手順
|
|
451
|
-
|
|
452
|
-
| 手順 | 内容 | 実施者 | 完了条件 | 証跡 |
|
|
453
|
-
| ---- | -------------------- | ----------- | ---------------- | ------------- |
|
|
454
|
-
| 1 | 申請受付(チケット) | Support/Ops | 必要情報が揃う | ticket_id |
|
|
455
|
-
| 2 | 承認 | Ops Lead | 承認コメントあり | 承認ログ |
|
|
456
|
-
| 3 | 付与/剥奪 | Ops | 権限反映確認 | 実施ログ |
|
|
457
|
-
| 4 | 検証 | 申請者 | ログイン確認 | スクショ/ログ |
|
|
458
|
-
| 5 | 記録 | Ops | 台帳更新 | 台帳 |
|
|
459
|
-
|
|
460
|
-
---
|
|
461
|
-
|
|
462
|
-
### 8.8. サンプル: opr-support(問い合わせ一次対応)
|
|
463
|
-
|
|
464
|
-
```yaml
|
|
465
|
-
---
|
|
466
|
-
id: opr-support
|
|
467
|
-
type: operations
|
|
468
|
-
title: 運用手順: 問い合わせ一次対応
|
|
469
|
-
status: draft
|
|
470
|
-
based_on: [opd-index]
|
|
471
|
-
supersedes: []
|
|
472
|
-
---
|
|
473
|
-
```
|
|
474
|
-
|
|
475
|
-
#### 8.8.1. 問い合わせ一次対応手順(テンプレ・ナレッジ)
|
|
476
|
-
|
|
477
|
-
- 分類:
|
|
478
|
-
- 仕様確認 / 障害疑い / 依頼(権限・設定) / データ修正要否
|
|
479
|
-
|
|
480
|
-
- 一次対応テンプレ(例):
|
|
481
|
-
- 受付→再現条件→影響→暫定回避→引継ぎ要否
|
|
482
|
-
|
|
483
|
-
- 引き継ぎ条件:
|
|
484
|
-
- 障害疑いは `opr-incident` へ(P判定を付与)
|