specdojo 0.8.0 → 0.9.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 +4 -1
- package/CHANGELOG.md +64 -0
- package/dist/catalog/catalog.js +16 -14
- package/dist/commands/agent.js +5 -3
- package/dist/commands/build.js +69 -10
- package/dist/commands/git.js +206 -0
- package/dist/commands/init.js +4 -2
- package/dist/commands/where.js +25 -0
- package/dist/dashboard/dashboard.js +5 -3
- package/dist/dashboard/routines.js +4 -7
- package/dist/dashboard/timeline.js +14 -14
- package/dist/docs/index-command.js +2 -2
- package/dist/docs/yaml-business-tables.js +243 -0
- package/dist/docs/yaml-interface-tables.js +106 -0
- package/dist/docs/yaml-pages-command.js +5 -3
- package/dist/docs/yaml-pages.js +146 -3
- package/dist/docs/yaml-table-shared.js +70 -0
- package/dist/docs/yaml-tables.js +39 -0
- package/dist/exec/agent-config.js +9 -0
- package/dist/exec/agent-protected-config.js +2 -0
- package/dist/exec/commands.js +31 -18
- package/dist/exec/events.js +34 -14
- package/dist/exec/evidence.js +13 -3
- package/dist/exec/parent-validation.js +56 -3
- package/dist/exec/plans-core.js +21 -2
- package/dist/exec/plans-generation.js +6 -7
- package/dist/exec/post-integration.js +162 -0
- package/dist/exec/queue-command.js +166 -0
- package/dist/exec/queue.js +285 -0
- package/dist/exec/register-foreign-wait.js +84 -0
- package/dist/exec/repo-integration-sync.js +17 -5
- package/dist/exec/reporter.js +2 -2
- package/dist/exec/results.js +24 -4
- package/dist/exec/review-kata.js +4 -1
- package/dist/exec/run/agent-pipeline.js +3 -2
- package/dist/exec/run/agent.js +12 -6
- package/dist/exec/run/change-scope.js +365 -0
- package/dist/exec/run/deferred-cleanup.js +31 -0
- package/dist/exec/run/in-place.js +4 -1
- package/dist/exec/run/job-lock.js +66 -0
- package/dist/exec/run/job-sequence.js +137 -0
- package/dist/exec/run/job.js +56 -19
- package/dist/exec/run/lifecycle-commands.js +1 -1
- package/dist/exec/run/lock.js +22 -1
- package/dist/exec/run/register-command.js +8 -5
- package/dist/exec/run/register-mode.js +68 -8
- package/dist/exec/run/register-resume.js +68 -14
- package/dist/exec/run/register-state.js +13 -8
- package/dist/exec/run/register-worktree.js +140 -125
- package/dist/exec/run/schedule-mode.js +75 -14
- package/dist/exec/run/schedule-prepare.js +3 -0
- package/dist/exec/run/schedule-task.js +88 -38
- package/dist/exec/run/shared.js +5 -0
- package/dist/exec/schedule/schedule.js +116 -4
- package/dist/exec/shared.js +1 -1
- package/dist/exec/smoke.js +190 -0
- package/dist/exec/strategy.js +13 -3
- package/dist/exec/task-view.js +6 -4
- package/dist/exec/trial-commands.js +5 -2
- package/dist/exec/trial-core.js +6 -1
- package/dist/exec/validation-metrics.js +181 -0
- package/dist/exec/worktree-cleanup-lock.js +26 -0
- package/dist/exec/worktree-command.js +9 -1
- package/dist/exec/worktree-ops-commit.js +2 -2
- package/dist/exec/worktree.js +13 -2
- package/dist/grade/command-apply.js +3 -3
- package/dist/grade/command-inspect.js +5 -3
- package/dist/grade/command-plan.js +1 -1
- package/dist/grade/command-run.js +5 -1
- package/dist/grade/run.js +64 -8
- package/dist/job/definition.js +84 -8
- package/dist/job/job.js +79 -23
- package/dist/register/authoring-sources.js +22 -16
- package/dist/register/maintenance-commands.js +2 -2
- package/dist/register/register.js +31 -7
- package/dist/routine/definition.js +9 -0
- package/dist/routine/routine.js +137 -43
- package/dist/routine/status.js +62 -0
- package/dist/schedule/schedule.js +38 -39
- package/dist/shared/agent-types.js +5 -0
- package/dist/shared/cross-process-lock.js +9 -1
- package/dist/shared/dist-freshness.js +8 -2
- package/dist/shared/git-environment.js +2 -1
- package/dist/shared/git.js +44 -1
- package/dist/shared/lefthook-scaffold.js +3 -0
- package/dist/shared/local-config.js +244 -0
- package/dist/shared/specdojo-config.js +34 -20
- package/dist/shared/specdojo-gitignore.js +1 -0
- package/dist/shared/text.js +9 -1
- package/dist/shared/where-alias.js +13 -0
- package/dist/specdojo.js +4 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +2 -0
- package/docs/ja/specdojo/guides/exec-config-guide.md +23 -4
- package/docs/ja/specdojo/guides/exec-operation-guide.md +44 -1
- package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +3 -3
- package/docs/ja/specdojo/guides/register-operation-guide.md +1 -1
- package/docs/ja/specdojo/guides/routine-operation-guide.md +11 -6
- package/docs/ja/specdojo/guides/schedule-design-guide.md +20 -17
- package/docs/ja/specdojo/guides/waza-guide.md +12 -8
- package/docs/ja/specdojo/recipes/bac-recipe.md +66 -49
- package/docs/ja/specdojo/recipes/bes-recipe.md +90 -54
- package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
- package/docs/ja/specdojo/recipes/br-recipe.md +40 -47
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +97 -109
- package/docs/ja/specdojo/recipes/cdfd-recipe.md +85 -146
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +91 -110
- package/docs/ja/specdojo/recipes/cnd-recipe.md +79 -69
- package/docs/ja/specdojo/recipes/cpd-recipe.md +78 -64
- package/docs/ja/specdojo/recipes/cxd-recipe.md +92 -75
- package/docs/ja/specdojo/recipes/ifd-recipe.md +79 -68
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +78 -105
- package/docs/ja/specdojo/recipes/ifx-index-recipe.md +105 -71
- package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +60 -49
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +50 -51
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +59 -51
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +69 -56
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +37 -56
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +39 -53
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -79
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -93
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -157
- package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +62 -111
- package/docs/ja/specdojo/recipes/prj-scope-recipe.md +67 -123
- package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +60 -96
- package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +61 -105
- package/docs/ja/specdojo/recipes/stsd-recipe.md +79 -109
- package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +78 -55
- package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +82 -73
- package/docs/ja/specdojo/recipes/sysd-index-recipe.md +78 -59
- package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
- package/docs/ja/specdojo/references/command-reference.md +257 -117
- package/docs/ja/specdojo/references/deliverables-reference.md +21 -12
- package/docs/ja/specdojo/references/specdojo-config-reference.md +37 -2
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +101 -257
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +102 -228
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +19 -28
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +16 -67
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +30 -51
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +41 -61
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +22 -50
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +13 -38
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +41 -76
- package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +18 -93
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +18 -52
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +109 -147
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +80 -108
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +21 -46
- package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +27 -48
- package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +37 -50
- package/docs/ja/specdojo/rulebooks/clis-rulebook.md +52 -69
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +16 -32
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +45 -131
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +69 -275
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +20 -112
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +23 -56
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +39 -47
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +37 -56
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +118 -175
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +5 -14
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +22 -66
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +36 -94
- package/docs/ja/specdojo/rulebooks/dss-rulebook.md +59 -81
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +31 -131
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +50 -104
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +51 -61
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +38 -45
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +26 -38
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +26 -107
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +42 -49
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +21 -44
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +14 -38
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +34 -61
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +27 -50
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +70 -199
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +65 -153
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +74 -150
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +11 -23
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +99 -176
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +35 -61
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +75 -117
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +31 -60
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +26 -81
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +32 -70
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +45 -87
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +48 -101
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +44 -80
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +59 -127
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +31 -50
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +42 -109
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +29 -42
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +29 -87
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +62 -84
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +11 -61
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +91 -106
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +25 -34
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +30 -53
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +23 -35
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +27 -45
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +37 -45
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +45 -46
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +37 -48
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +25 -29
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +36 -41
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +5 -18
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +16 -37
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +39 -57
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +43 -116
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +16 -51
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +47 -92
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +25 -84
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +44 -107
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +39 -49
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +42 -49
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +64 -89
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +90 -189
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +45 -105
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +6 -12
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +49 -68
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +51 -60
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +46 -50
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +39 -64
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -70
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +65 -72
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +35 -46
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +49 -66
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +64 -139
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +41 -108
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +49 -144
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +67 -155
- package/docs/ja/specdojo/samples/bds-sample.md +58 -71
- package/docs/ja/specdojo/samples/bes-index-sample.md +20 -37
- package/docs/ja/specdojo/samples/bes-sample.md +43 -53
- package/docs/ja/specdojo/samples/bps-sample.md +42 -54
- package/docs/ja/specdojo/samples/br-sample.md +40 -52
- package/docs/ja/specdojo/samples/ccd-sample.md +0 -1
- package/docs/ja/specdojo/samples/cdr-sample.md +78 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +47 -63
- package/docs/ja/specdojo/samples/clis-sample.md +70 -77
- package/docs/ja/specdojo/samples/dec-sample.md +2 -3
- package/docs/ja/specdojo/samples/ifx-api-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/ifx-msg-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/job-sequence.yaml +67 -0
- package/docs/ja/specdojo/samples/mip-index-sample.md +98 -20
- package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +26 -19
- package/docs/ja/specdojo/samples/pm-organization-sample.md +39 -50
- package/docs/ja/specdojo/samples/pm-plan-sample.md +61 -67
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +31 -45
- package/docs/ja/specdojo/samples/pm-raci-sample.md +31 -37
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +32 -48
- package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +55 -61
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
- package/docs/ja/specdojo/samples/sf-index-sample.md +13 -55
- package/docs/ja/specdojo/samples/sf-sample.md +73 -85
- package/docs/ja/specdojo/samples/sld-sample.md +60 -79
- package/docs/ja/specdojo/samples/uis-sample.md +98 -121
- package/docs/ja/specdojo/standards/job-definition-standard.md +24 -9
- package/docs/ja/specdojo/templates/cdr-template.md +58 -0
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +2 -1
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +42 -5
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +35 -0
- package/docs/specdojo/schemas/v1/job-run.schema.yaml +23 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +63 -2
- package/docs/specdojo/schemas/v1/sch-strategy.schema.yaml +2 -2
- package/package.json +9 -6
- package/templates/antigravity/orchestrator.md +4 -1
- package/templates/claude/agents/specdojo-orchestrator.md +4 -1
- package/templates/codex/agents/specdojo-orchestrator.toml +4 -1
- package/templates/codex/orchestrator.md +4 -1
- package/templates/init-exec-defaults.yaml +13 -0
- package/templates/lefthook/tools/specdojo-pre-commit.mjs +8 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +5 -2
|
@@ -13,22 +13,21 @@ specdojo:
|
|
|
13
13
|
|
|
14
14
|
Non-Functional Requirements Security and Safety Documentation Rules
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
機密性・安全性要件は、権限逸脱や情報漏えいを防ぐ基準を定量化する。
|
|
16
|
+
本書は、非機能要件のうち機密性・安全性(認証、認可、保護、監査)を定義する `nfr-security-safety` の作成ルールを定める。
|
|
18
17
|
|
|
19
18
|
## 1. 全体方針
|
|
20
19
|
|
|
21
20
|
- 機密性・安全性はアクセス制御、情報保護、監査可能性で定義する。
|
|
22
21
|
- 要件は「許可されない操作が実行されない」ことを基準化する。
|
|
23
22
|
- 脅威・規制要件に対する検証可能な制約として記述する。
|
|
23
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直さない。文書の整形・lint はリポジトリの検証で扱い、「測定・検証方法」に含めない。
|
|
24
24
|
|
|
25
25
|
## 2. 位置づけと用語定義(必要に応じて)
|
|
26
26
|
|
|
27
27
|
### 2.1. 位置づけ
|
|
28
28
|
|
|
29
|
-
- `nfr-security-safety`:機密性・安全性要求の正本
|
|
30
29
|
- `nfr-index`:NFR全体の入口
|
|
31
|
-
- `sac-*` / `stc
|
|
30
|
+
- `sac-*` / `stc-*`:機密性・安全性要件の検証先
|
|
32
31
|
- `opd-*` / `opr-*`:監視・インシデント対応
|
|
33
32
|
|
|
34
33
|
### 2.2. 用語定義
|
|
@@ -49,19 +48,14 @@ Non-Functional Requirements Security and Safety Documentation Rules
|
|
|
49
48
|
|
|
50
49
|
### 4.1. 設定内容
|
|
51
50
|
|
|
52
|
-
|
|
51
|
+
許可キー・必須項目・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とする。
|
|
53
52
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
| id | `nfr-security-safety` | ○ |
|
|
57
|
-
| type | `requirement` 固定 | ○ |
|
|
58
|
-
| title | 非機能要件: 機密性・安全性 | ○ |
|
|
59
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
60
|
-
| part_of | `nfr-index` | 任意 |
|
|
53
|
+
- `specdojo.id` は `nfr-security-safety`、`specdojo.type` は `requirement`、`specdojo.rulebook` は `specdojo:nfr-security-safety-rulebook` とする。
|
|
54
|
+
- `specdojo.part_of` には `nfr-index` を置く。
|
|
61
55
|
|
|
62
56
|
### 4.2. 推奨ルール
|
|
63
57
|
|
|
64
|
-
-
|
|
58
|
+
- 規制・監査基準(個人情報保護法、社内セキュリティポリシー等)への適合要件がある場合は、その根拠文書を `specdojo.based_on` に挙げる。
|
|
65
59
|
|
|
66
60
|
## 5. 本文構成(標準テンプレ)
|
|
67
61
|
|
|
@@ -73,8 +67,7 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
73
67
|
| 2 | 適用範囲・脅威前提 | ○ |
|
|
74
68
|
| 3 | 機密性・安全性要件一覧 | ○ |
|
|
75
69
|
| 4 | 測定・検証方法 | ○ |
|
|
76
|
-
|
|
77
|
-
| 5 | 関連ドキュメント導線 | ○ |
|
|
70
|
+
| 5 | 関連ドキュメント導線 | ○ |
|
|
78
71
|
|
|
79
72
|
## 6. 記述ガイド
|
|
80
73
|
|
|
@@ -88,26 +81,28 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
88
81
|
|
|
89
82
|
生成する本文の見出しは **## 2. 適用範囲・脅威前提**
|
|
90
83
|
|
|
91
|
-
-
|
|
84
|
+
- 想定脅威、対象境界、適用する規制、対象外を表で明記する。
|
|
92
85
|
|
|
93
86
|
### 6.3. 機密性・安全性要件一覧
|
|
94
87
|
|
|
95
88
|
生成する本文の見出しは **## 3. 機密性・安全性要件一覧**
|
|
96
89
|
|
|
97
|
-
- 表形式(`id` / `内容` / `指標` / `基準` /
|
|
98
|
-
-
|
|
90
|
+
- 表形式(`id` / `内容` / `指標` / `基準` / `備考`)で記述し、認証・認可・情報保護・監査を別の行に分ける。
|
|
91
|
+
- 「基準」は件数・割合・期限などの判定値で書く。指標例:認可逸脱件数、脆弱性修正SLA、監査ログ欠落率。
|
|
92
|
+
- **良い例**: 「権限外ユーザーは顧客情報を参照できない / 認可逸脱件数 / 0 件/四半期」
|
|
93
|
+
- **悪い例**: 「顧客情報を安全に管理する / - / 適切に」(指標も判定値もなく検証できない)
|
|
99
94
|
|
|
100
95
|
### 6.4. 測定・検証方法
|
|
101
96
|
|
|
102
97
|
生成する本文の見出しは **## 4. 測定・検証方法**
|
|
103
98
|
|
|
104
|
-
-
|
|
99
|
+
- 要件IDごとに、セキュリティ試験・監査ログ検証・脆弱性スキャンなどの測定方法と判定時期を定める。
|
|
105
100
|
|
|
106
101
|
### 6.5. 関連ドキュメント導線
|
|
107
102
|
|
|
108
103
|
生成する本文の見出しは **## 5. 関連ドキュメント導線**
|
|
109
104
|
|
|
110
|
-
- `
|
|
105
|
+
- 「位置づけ」の文書、設計判断の `dec-*`、セキュリティ方針文書を、種別・ドキュメントID・目的の表で紐づける。
|
|
111
106
|
|
|
112
107
|
## 7. 禁止事項
|
|
113
108
|
|
|
@@ -119,69 +114,38 @@ Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schema
|
|
|
119
114
|
|
|
120
115
|
## 8. サンプル
|
|
121
116
|
|
|
122
|
-
|
|
117
|
+
注:形式の輪郭を示す最小例。成果物の見出しは `## 1...` から始まる。
|
|
123
118
|
|
|
124
119
|
```yaml
|
|
125
120
|
---
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
status: draft
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
supersedes: []
|
|
121
|
+
specdojo:
|
|
122
|
+
id: nfr-security-safety
|
|
123
|
+
type: requirement
|
|
124
|
+
status: draft
|
|
125
|
+
rulebook: specdojo:nfr-security-safety-rulebook
|
|
126
|
+
part_of: [nfr-index]
|
|
133
127
|
---
|
|
134
128
|
```
|
|
135
129
|
|
|
136
|
-
### 8.1.
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
### 8.2.
|
|
144
|
-
|
|
145
|
-
|
|
|
146
|
-
|
|
|
147
|
-
|
|
|
148
|
-
|
|
|
149
|
-
|
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
|
156
|
-
|
|
|
157
|
-
| nfr-sec-
|
|
158
|
-
| nfr-sec-002 | 重大脆弱性は期限内に修正する | 修正 SLA 達成率 | 95% 以上 | CVSS 7.0 以上対象 |
|
|
159
|
-
| nfr-sec-003 | 認証は多要素認証を必須とする | MFA 適用率 | 100% | 管理者・一般ユーザー共通 |
|
|
160
|
-
| nfr-sec-004 | セッションタイムアウトを基準内に設定する | アイドルタイムアウト | 30 分 | トークンベース |
|
|
161
|
-
| nfr-sec-005 | 監査ログは改ざん不能で保管すること | ログ改ざん検知率 | 100% | WORM ストレージ採用 |
|
|
162
|
-
| nfr-sec-006 | API 入力は全エンドポイントでバリデーションすること | バリデーション網羅率 | 100% | OpenAPI スキーマ検証必須 |
|
|
163
|
-
| nfr-sec-007 | 機密データは保管時・転送時に暗号化すること | 暗号化適用率 | 100% | AES-256 / TLS 1.2 以上 |
|
|
164
|
-
|
|
165
|
-
### 8.4. 測定・検証方法(例)
|
|
166
|
-
|
|
167
|
-
| 要件ID | 測定方法 | 判定タイミング | 判定者 |
|
|
168
|
-
| ----------- | ------------------------------------------------ | ------------------- | ------------ |
|
|
169
|
-
| nfr-sec-001 | ペネトレーションテスト(権限かいくぐりシナリオ) | リリース前 / 四半期 | セキュリティ |
|
|
170
|
-
| nfr-sec-002 | 脆弱性管理ツールの修正完了データ | 月次集計 | セキュリティ |
|
|
171
|
-
| nfr-sec-003 | 認証プロバイダの MFA 設定状況確認 | 四半期監査 | SRE |
|
|
172
|
-
| nfr-sec-004 | トークン有効期限の設定値をレビュー | リリース前レビュー | QA / SRE |
|
|
173
|
-
| nfr-sec-005 | WORM ストレージの書き込み禁止確認テスト | 四半期監査 | DBA / SRE |
|
|
174
|
-
| nfr-sec-006 | OpenAPI スキーマ検証テストを CI で実行 | merge 毎 | QA |
|
|
175
|
-
| nfr-sec-007 | TLS バージョン・暗号化設定のスキャン | 四半期スキャン | Infra / SRE |
|
|
176
|
-
|
|
177
|
-
### 8.5. 関連ドキュメント導線(例)
|
|
178
|
-
|
|
179
|
-
| 種別 | ドキュメントID | 目的 | 備考 |
|
|
180
|
-
| ---------------- | ---------------- | --------------------------- | ---- |
|
|
181
|
-
| NFR 入口 | nfr-index | 非機能要件全体の俯瞰 | 必須 |
|
|
182
|
-
| 受入条件 | sac-\* | セキュリティ要件の合否判定 | 必須 |
|
|
183
|
-
| システム試験 | stc-\* | セキュリティ観点の E2E 試験 | 必須 |
|
|
184
|
-
| 運用設計 | opd-\* | 監視・インシデント対応基準 | 必須 |
|
|
185
|
-
| 運用手順 | opr-\* | インシデント一次対応手順 | 必須 |
|
|
186
|
-
| 判断記録 | dec-\* | セキュリティ設計判断の追跡 | 任意 |
|
|
187
|
-
| セキュリティ方針 | (社内ポリシー) | 規制・社内基準との整合確認 | 任意 |
|
|
130
|
+
### 8.1. 適用範囲・脅威前提(例)
|
|
131
|
+
|
|
132
|
+
| 項目 | 内容 |
|
|
133
|
+
| -------- | ---------------------------------------- |
|
|
134
|
+
| 想定脅威 | 不正ログイン、権限昇格、インジェクション |
|
|
135
|
+
| 対象外 | 物理セキュリティ(別文書) |
|
|
136
|
+
|
|
137
|
+
### 8.2. 機密性・安全性要件一覧(例)
|
|
138
|
+
|
|
139
|
+
| id | 内容 | 指標 | 基準 | 備考 |
|
|
140
|
+
| ----------- | -------------------------------------------- | --------------- | ----------- | ----------------- |
|
|
141
|
+
| nfr-sec-001 | 権限外ユーザーは機密データを参照できないこと | 認可逸脱件数 | 0 件/四半期 | STC で検証 |
|
|
142
|
+
| nfr-sec-002 | 重大脆弱性は期限内に修正する | 修正 SLA 達成率 | 95% 以上 | CVSS 7.0 以上対象 |
|
|
143
|
+
| nfr-sec-003 | 監査ログは改ざん不能で保管すること | 改ざん検知率 | 100% | WORM ストレージ |
|
|
144
|
+
|
|
145
|
+
### 8.3. 測定・検証方法(例)
|
|
146
|
+
|
|
147
|
+
| 要件ID | 測定方法 | 判定タイミング |
|
|
148
|
+
| ----------- | ------------------------------------------------ | ------------------- |
|
|
149
|
+
| nfr-sec-001 | ペネトレーションテスト(権限かいくぐりシナリオ) | リリース前 / 四半期 |
|
|
150
|
+
| nfr-sec-002 | 脆弱性管理ツールの修正完了データ | 月次集計 |
|
|
151
|
+
| nfr-sec-003 | WORM ストレージの書き込み禁止確認テスト | 四半期監査 |
|
|
@@ -13,173 +13,105 @@ specdojo:
|
|
|
13
13
|
|
|
14
14
|
Non-Functional Requirements Usability Documentation Rules
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
操作性要件は、利用者が誤りなく効率的に操作できることを検証可能に記述する。
|
|
16
|
+
操作性(使いやすさ・誤操作防止・学習容易性)の非機能要件 `nfr-usability` の作成ルールを定めます。
|
|
18
17
|
|
|
19
18
|
## 1. 全体方針
|
|
20
19
|
|
|
21
|
-
-
|
|
22
|
-
- UI表現の詳細設計ではなく、利用結果としての品質基準を書く。
|
|
23
|
-
-
|
|
20
|
+
- 操作性は、利用者前提を置いたうえで指標と基準値で定義し、受入試験やユーザ検証で合否を判定できるようにする。
|
|
21
|
+
- UI 表現の詳細設計ではなく、利用結果としての品質基準を書く。
|
|
22
|
+
- **共通の運用**: 役割の割り当ては適用先のメンバー定義に、`status` の昇格と承認、改訂と廃止、未決事項の登録簿への引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従い、本書と成果物で言い直さない。文書の整形・lint はリポジトリの検証で扱い、成果物の測定・検証方法に含めない。
|
|
24
23
|
|
|
25
|
-
## 2.
|
|
24
|
+
## 2. 位置づけ
|
|
26
25
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
- `nfr-usability`:操作性要求の正本
|
|
30
|
-
- `nfr-index`:NFR全体の入口
|
|
31
|
-
- `uis-*`:画面仕様の参照先
|
|
32
|
-
- `sac-*` / `stc-*`:操作性検証の受入・試験仕様
|
|
33
|
-
|
|
34
|
-
### 2.2. 用語定義
|
|
35
|
-
|
|
36
|
-
| 用語 | 定義 |
|
|
37
|
-
| ------------ | ---------------------------------------- |
|
|
38
|
-
| 操作性 | 利用者が目的タスクを迷わず完了できる性質 |
|
|
39
|
-
| タスク完了率 | 指定タスクを完了できた割合 |
|
|
40
|
-
| 誤操作率 | 望まない操作を実行した割合 |
|
|
26
|
+
- `nfr-usability` は操作性要求の正本で、`nfr-index` を入口とする。
|
|
27
|
+
- 画面仕様は `uis-*`、受入・試験仕様は `sac-*` / `stc-*` を正本とし、本書から参照する。
|
|
41
28
|
|
|
42
29
|
## 3. ファイル命名・ID規則
|
|
43
30
|
|
|
44
|
-
-
|
|
45
|
-
-
|
|
46
|
-
- 要件IDは `nfr-usb-<連番>` を推奨する。
|
|
31
|
+
- 生成対象ドキュメント ID は `nfr-usability` を推奨する。
|
|
32
|
+
- 要件 ID は `nfr-usb-<連番>`(3 桁)を推奨する。
|
|
47
33
|
|
|
48
34
|
## 4. 推奨 Frontmatter 項目
|
|
49
35
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
Frontmatter は共通スキーマに従います(参照: [docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml](../../../specdojo/schemas/v1/deliverable-frontmatter.schema.yaml) / [document-metadata-standard.md](../standards/document-metadata-standard.md))。
|
|
53
|
-
|
|
54
|
-
| 項目 | 説明 | 必須 |
|
|
55
|
-
| ------- | -------------------------------- | ---- |
|
|
56
|
-
| id | `nfr-usability` | ○ |
|
|
57
|
-
| type | `requirement` 固定 | ○ |
|
|
58
|
-
| title | 非機能要件: 操作性 | ○ |
|
|
59
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
60
|
-
| part_of | `nfr-index` | 任意 |
|
|
36
|
+
許可キー・必須項目・型制約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` を正本とします。
|
|
61
37
|
|
|
62
|
-
|
|
38
|
+
- `specdojo.type` は `requirement`、`specdojo.rulebook` は `specdojo:nfr-usability-rulebook` とする。
|
|
39
|
+
- `specdojo.part_of` は `nfr-index` とする(任意)。
|
|
63
40
|
|
|
64
|
-
|
|
41
|
+
## 5. 本文要件
|
|
65
42
|
|
|
66
|
-
|
|
43
|
+
見出しは次の構成で **順序固定** とする。
|
|
67
44
|
|
|
68
|
-
|
|
45
|
+
| 番号 | 見出し | 必須 | 受入条件 |
|
|
46
|
+
| ---- | -------------------- | ---- | -------------------------------------------------------------- |
|
|
47
|
+
| 1 | 概要(対象・目的) | ○ | 対象利用者と、どの業務の操作品質を守るかが分かる |
|
|
48
|
+
| 2 | 適用範囲・利用者前提 | ○ | 対象画面・対象業務・利用者属性(熟練度・利用環境)が揃っている |
|
|
49
|
+
| 3 | 操作性要件一覧 | ○ | 全要件が標準 5 列で、指標と基準値から合否を判定できる |
|
|
50
|
+
| 4 | 測定・検証方法 | ○ | 全要件 ID に測定方法・判定タイミング・判定者がある |
|
|
51
|
+
| 5 | 関連ドキュメント導線 | ○ | `nfr-index`・`sac-*`・`stc-*`・`uis-*` への導線がある |
|
|
69
52
|
|
|
70
|
-
|
|
71
|
-
| ---- | -------------------- | ---- |
|
|
72
|
-
| 1 | 概要(対象・目的) | ○ |
|
|
73
|
-
| 2 | 適用範囲・利用者前提 | ○ |
|
|
74
|
-
| 3 | 操作性要件一覧 | ○ |
|
|
75
|
-
| 4 | 測定・検証方法 | ○ |
|
|
76
|
-
| 5 | 関連ドキュメント導線 | ○ |
|
|
53
|
+
「操作性要件一覧」の標準 5 列は `id` / `内容` / `指標` / `基準` / `備考` の順とする。`基準` は数値と単位、または網羅条件(`100%`)で書き、`備考` に対象利用者・対象操作を絞り込む。
|
|
77
54
|
|
|
78
55
|
## 6. 記述ガイド
|
|
79
56
|
|
|
80
|
-
|
|
57
|
+
完成例の全体像は Frontmatter の `sample` で宣言された sample を参照してください。
|
|
81
58
|
|
|
82
|
-
|
|
59
|
+
### 6.1. 概要(対象・目的)
|
|
83
60
|
|
|
84
|
-
-
|
|
61
|
+
- **判断基準**: 誰がどの業務タスクで、何を防ぎたいか(迷い・誤操作・習熟の遅れ)が 2〜3 文で分かること。
|
|
85
62
|
|
|
86
63
|
### 6.2. 適用範囲・利用者前提
|
|
87
64
|
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
-
|
|
65
|
+
- **判断基準**: 基準値がどの利用者・環境で成り立つか特定できること。属性で基準が変わる場合は属性を分けて書く。
|
|
66
|
+
- **良い例**: 「新任利用者: 業務知識あり・システム未経験 / 対象デバイス: 店頭のタブレット端末」
|
|
67
|
+
- **悪い例**: 「一般利用者」(熟練度も利用環境も分からず、試験の被験者を選べない)
|
|
91
68
|
|
|
92
69
|
### 6.3. 操作性要件一覧
|
|
93
70
|
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
-
|
|
97
|
-
- 指標例:タスク完了率、平均完了時間、誤操作率。
|
|
71
|
+
- **判断基準**: 1 行 1 指標とし、指標・基準値・`備考` の対象から合否を出せること。指標は完了率・完了時間・誤操作率・習熟時間・エラーメッセージの対処方法含有率・破壊的操作の確認網羅率などから選ぶ。
|
|
72
|
+
- **良い例**: 「`nfr-usb-002` / 誤操作を基準以下に抑える / 誤操作率 / 2% 以下 / 取消導線を提供」
|
|
73
|
+
- **悪い例**: 「レジ画面は使いやすいこと / 操作性 / 良好」(指標も基準値もなく判定できない)
|
|
98
74
|
|
|
99
75
|
### 6.4. 測定・検証方法
|
|
100
76
|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
-
|
|
77
|
+
- **判断基準**: 要件 ID ごとに、測定手段(ユーザビリティテスト・操作ログ集計・レビュー)と被験者数などの条件、判定の時期と判定者が分かること。
|
|
78
|
+
- **良い例**: 「`nfr-usb-001` / ユーザビリティテスト(新任 5 名×主要タスク) / リリース前受入試験 / UX・QA」
|
|
79
|
+
- **悪い例**: 「利用者アンケートで確認する。」(どの要件をどの基準で判定するか分からない)
|
|
104
80
|
|
|
105
81
|
### 6.5. 関連ドキュメント導線
|
|
106
82
|
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
- `uis-*`、`sac-*`、`stc-*`、`dec-*` への導線を記載する。
|
|
83
|
+
- **判断基準**: 合否基準(`sac-*`)、試験(`stc-*`)、画面仕様(`uis-*`)、設計判断(`dec-*`、任意)の参照先と目的が表で分かること。
|
|
110
84
|
|
|
111
85
|
## 7. 禁止事項
|
|
112
86
|
|
|
113
|
-
| 禁止事項
|
|
114
|
-
|
|
|
115
|
-
|
|
116
|
-
|
|
|
117
|
-
|
|
|
118
|
-
|
|
|
87
|
+
| 禁止事項 | 理由 |
|
|
88
|
+
| ------------------------------ | ------------------------------------------ |
|
|
89
|
+
| 「使いやすい」だけで要件を書く | 判定不能のため |
|
|
90
|
+
| 画面詳細仕様を丸ごと再掲する | `uis-*` と二重管理になるため |
|
|
91
|
+
| 利用者前提を書かない | 評価条件が揃わないため |
|
|
92
|
+
| 測定方法のない要件 ID を置く | 受入試験で合否を出せず要件が形骸化するため |
|
|
119
93
|
|
|
120
94
|
## 8. サンプル
|
|
121
95
|
|
|
122
|
-
|
|
96
|
+
注: 形式の輪郭を示す最小例(一部の章のみ)。
|
|
123
97
|
|
|
124
|
-
```
|
|
98
|
+
```markdown
|
|
125
99
|
---
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
status: draft
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
100
|
+
specdojo:
|
|
101
|
+
id: nfr-usability
|
|
102
|
+
type: requirement
|
|
103
|
+
status: draft
|
|
104
|
+
rulebook: specdojo:nfr-usability-rulebook
|
|
105
|
+
part_of:
|
|
106
|
+
- nfr-index
|
|
133
107
|
---
|
|
134
|
-
```
|
|
135
108
|
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
| 項目 | 内容 |
|
|
146
|
-
| ------------ | ---------------------------------------------------- |
|
|
147
|
-
| 対象画面 | GCS Web UI(受注管理・在庫照会・会計ダッシュボード) |
|
|
148
|
-
| 対象業務 | 受注登録・在庫確認・請求書発行・売上確定 |
|
|
149
|
-
| 利用者属性 | 業務担当者(PC・ブラウザ操作に慣れた一般事務職) |
|
|
150
|
-
| 新任利用者 | 業務知識あり・システム未経験 |
|
|
151
|
-
| 対象デバイス | デスクトップ PC(Chrome 最新版 / 解像度 1920×1080) |
|
|
152
|
-
|
|
153
|
-
### 8.3. 操作性要件一覧(例)
|
|
154
|
-
|
|
155
|
-
| id | 内容 | 指標 | 基準 | 備考 |
|
|
156
|
-
| ----------- | ------------------------------------------ | -------------------- | ---------- | ------------------------ |
|
|
157
|
-
| nfr-usb-001 | 主要業務タスクを迷わず完了できること | タスク完了率 | 95% 以上 | 新任利用者対象 |
|
|
158
|
-
| nfr-usb-002 | 誤操作を基準以下に抑える | 誤操作率 | 2% 以下 | 取消導線を提供 |
|
|
159
|
-
| nfr-usb-003 | 新任利用者が基本操作を習得できること | 習得時間 | 2 時間以内 | オンボーディングガイド付 |
|
|
160
|
-
| nfr-usb-004 | 受注登録は基準時間内に完了できること | 平均完了時間 | 3 分以内 | 入力フィールド 15 件以内 |
|
|
161
|
-
| nfr-usb-005 | エラーメッセージは対処方法を含むこと | 対処方法含有率 | 100% | 「…してください」形式 |
|
|
162
|
-
| nfr-usb-006 | 破壊的操作には確認ダイアログを表示すること | 確認ダイアログ網羅率 | 100% | 削除・取消・上書き |
|
|
163
|
-
| nfr-usb-007 | キーボードのみで主要操作が完了できること | キーボード操作完結率 | 90% 以上 | アクセシビリティ対応 |
|
|
164
|
-
|
|
165
|
-
### 8.4. 測定・検証方法(例)
|
|
166
|
-
|
|
167
|
-
| 要件ID | 測定方法 | 判定タイミング | 判定者 |
|
|
168
|
-
| ----------- | -------------------------------------------- | --------------------- | ------------- |
|
|
169
|
-
| nfr-usb-001 | ユーザビリティテスト(5 名×主要タスク) | リリース前受入試験 | UX / QA |
|
|
170
|
-
| nfr-usb-002 | 操作ログから誤操作イベントを集計 | 月次集計 | UX |
|
|
171
|
-
| nfr-usb-003 | 新任利用者オンボーディング後の操作確認テスト | リリース後 1 か月以内 | UX / 業務部門 |
|
|
172
|
-
| nfr-usb-004 | タスク計測(受注登録開始〜完了までの時間) | ユーザビリティテスト | UX / QA |
|
|
173
|
-
| nfr-usb-005 | エラーメッセージ一覧の対処方法含有率を確認 | リリース前レビュー | QA |
|
|
174
|
-
| nfr-usb-006 | 破壊的操作一覧と確認ダイアログ実装状況の突合 | リリース前レビュー | QA |
|
|
175
|
-
| nfr-usb-007 | キーボード操作で主要タスクを実行し完結を確認 | リリース前試験 | QA |
|
|
176
|
-
|
|
177
|
-
### 8.5. 関連ドキュメント導線(例)
|
|
178
|
-
|
|
179
|
-
| 種別 | ドキュメントID | 目的 | 備考 |
|
|
180
|
-
| ------------ | -------------- | ---------------------------- | ---- |
|
|
181
|
-
| NFR 入口 | nfr-index | 非機能要件全体の俯瞰 | 必須 |
|
|
182
|
-
| 受入条件 | sac-\* | 操作性要件の合否判定基準 | 必須 |
|
|
183
|
-
| システム試験 | stc-\* | 操作性観点の E2E 試験 | 必須 |
|
|
184
|
-
| 画面仕様 | uis-\* | 画面レイアウト・操作フロー | 必須 |
|
|
185
|
-
| 判断記録 | dec-\* | 操作性に関する設計判断の追跡 | 任意 |
|
|
109
|
+
# 非機能要件: 操作性
|
|
110
|
+
|
|
111
|
+
## 3. 操作性要件一覧
|
|
112
|
+
|
|
113
|
+
| id | 内容 | 指標 | 基準 | 備考 |
|
|
114
|
+
| ----------- | ------------------------------------ | ------------ | ---------- | -------------- |
|
|
115
|
+
| nfr-usb-001 | 主要業務タスクを迷わず完了できること | タスク完了率 | 95% 以上 | 新任利用者対象 |
|
|
116
|
+
| nfr-usb-003 | 新任利用者が基本操作を習得できること | 習得時間 | 2 時間以内 | ガイド付き |
|
|
117
|
+
```
|
|
@@ -5,81 +5,62 @@ specdojo:
|
|
|
5
5
|
deliverable_type: operations
|
|
6
6
|
status: draft
|
|
7
7
|
target_format: markdown
|
|
8
|
-
recipe:
|
|
8
|
+
recipe: not-needed
|
|
9
9
|
sample: specdojo:opd-index-sample
|
|
10
|
-
template:
|
|
10
|
+
template: not-needed
|
|
11
11
|
---
|
|
12
12
|
|
|
13
13
|
# 運用方針・設計 全体構成 作成ルール
|
|
14
14
|
|
|
15
15
|
Operations Policy and Design Index Documentation Rules
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
恒常運用の方針・統制の正本となる `opd-index` の記述基準を定める。
|
|
18
18
|
|
|
19
19
|
## 1. 全体方針
|
|
20
20
|
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
|
|
24
|
-
- 実行手順の詳細は `opr-*` に委譲し、方針と手順の責務を分離する。
|
|
21
|
+
- SLO/SLA/KPI、責任分界、変更管理、復旧方針を判定可能にする。
|
|
22
|
+
- 本文構成と記述ガイドで骨組み・記入基準が定まるため、別の recipe・template は不要とする。
|
|
23
|
+
- **共通の運用**: 役割は適用先のメンバー定義、`status`・承認・改訂と廃止・未決事項の引き継ぎは [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] に従う。整形・lint はリポジトリの検証で扱う。
|
|
25
24
|
|
|
26
25
|
## 2. 位置づけと用語定義
|
|
27
26
|
|
|
28
|
-
|
|
29
|
-
- `opd-<term>` は `opd-index` の差分(補足・具体化・例外)を記述する。
|
|
30
|
-
- `opr-index` / `opr-<term>` は手順書であり、実行手順と証跡を定義する。
|
|
27
|
+
`opd-index` を入口・方針の正本とし、`opd-<term>` は差分(補足・具体化・例外)、`opr-*` は実行手順と証跡を担う。
|
|
31
28
|
|
|
32
29
|
## 3. ファイル命名・ID規則
|
|
33
30
|
|
|
34
|
-
-
|
|
35
|
-
- ファイル名は
|
|
36
|
-
-
|
|
31
|
+
- ID は `opd-index`、分冊は `opd-<term>`(kebab-case)とする。
|
|
32
|
+
- ファイル名は ID と同名の `.md` を推奨する。
|
|
33
|
+
- 配置は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] の `docs/ja/product/090-operations/` を推奨する。
|
|
37
34
|
|
|
38
35
|
## 4. 推奨 Frontmatter 項目
|
|
39
36
|
|
|
40
|
-
|
|
41
|
-
| ---- | ----------- | ---- |
|
|
42
|
-
| `id` | `opd-index` | ○ |
|
|
43
|
-
|
|
44
|
-
| `type` | `operations` | ○ |
|
|
45
|
-
| `status` | `draft` / `ready` / `deprecated` | ○ |
|
|
46
|
-
| `rulebook` | `specdojo:opd-index-rulebook` | 任意 |
|
|
47
|
-
|
|
48
|
-
| `based_on` | 根拠仕様 ID 配列 | 任意 |
|
|
49
|
-
| `supersedes` | 置換関係 ID 配列 | 任意 |
|
|
37
|
+
共通項目・必須性・型はドキュメントメタ情報標準と `docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml` に従う。`specdojo.type` は `operations`、`specdojo.rulebook` は `specdojo:opd-index-rulebook` とする。
|
|
50
38
|
|
|
51
39
|
## 5. 本文構成(標準テンプレ)
|
|
52
40
|
|
|
53
|
-
| 章 | 内容
|
|
54
|
-
| --- |
|
|
55
|
-
|
|
56
|
-
|
|
|
57
|
-
|
|
|
58
|
-
|
|
59
|
-
|
|
|
60
|
-
|
|
|
61
|
-
|
|
|
62
|
-
|
|
|
63
|
-
|
|
|
64
|
-
|
|
65
|
-
|
|
|
66
|
-
|
|
|
67
|
-
| 10 | 定期運用方針(バッチ・点検) | ○ |
|
|
68
|
-
|
|
69
|
-
| 11 | 問い合わせ運用方針(窓口・分類・SLA) | ○ |
|
|
70
|
-
| 12 | 関連ドキュメント導線(`opr-index` 等) | ○ |
|
|
41
|
+
| 章 | 内容 | 必須 |
|
|
42
|
+
| --- | -------------------------------------------------- | ---- |
|
|
43
|
+
| 1 | 概要(index) | ○ |
|
|
44
|
+
| 2 | 運用の範囲・前提 | ○ |
|
|
45
|
+
| 3 | SLO・SLA・KPI | ○ |
|
|
46
|
+
| 4 | 体制・責任分界(RACI・当番・エスカレーション) | ○ |
|
|
47
|
+
| 5 | 監視・アラート方針(指標・閾値・通知先・初動) | ○ |
|
|
48
|
+
| 6 | 障害対応方針(優先度・停止判断・周知) | ○ |
|
|
49
|
+
| 7 | 変更管理(リリース・設定変更・承認・ロールバック) | ○ |
|
|
50
|
+
| 8 | バックアップ・リストア方針(RTO/RPO) | ○ |
|
|
51
|
+
| 9 | 権限・アカウント運用(棚卸し・監査ログ) | ○ |
|
|
52
|
+
| 10 | 定期運用方針(バッチ・点検) | ○ |
|
|
53
|
+
| 11 | 問い合わせ運用方針(窓口・分類・SLA) | ○ |
|
|
54
|
+
| 12 | 関連ドキュメント導線(`opr-index` 等) | ○ |
|
|
71
55
|
|
|
72
56
|
## 6. 記述ガイド
|
|
73
57
|
|
|
74
|
-
- SLO/SLA/KPI
|
|
75
|
-
- 体制は RACI
|
|
76
|
-
-
|
|
77
|
-
- バックアップ方針は RTO/RPO と検証頻度を明記する。
|
|
78
|
-
- 関連ドキュメント導線には `opr-index` を必ず含める。
|
|
58
|
+
- SLO/SLA/KPI の標準列は「指標・数値目標・測定期間・測定方法・証跡・判定者」とする。
|
|
59
|
+
- 体制は RACI・当番・優先度別エスカレーション条件、監視・障害・変更管理は条件・判断者・通知先を示す。
|
|
60
|
+
- 復旧は RTO/RPO・検証頻度、関連導線は `opr-index` を含める。
|
|
79
61
|
|
|
80
62
|
## 7. 禁止事項
|
|
81
63
|
|
|
82
|
-
-
|
|
83
|
-
- SLO/SLA/KPI
|
|
84
|
-
-
|
|
85
|
-
- 変更承認条件とロールバック条件を省略しない。
|
|
64
|
+
- コマンド列・逐次チェックリストを大量記載しない。
|
|
65
|
+
- SLO/SLA/KPI を曖昧語だけで定義しない。
|
|
66
|
+
- 責任分界・エスカレーション条件を未定義のまま確定せず、変更承認・ロールバック条件を省略しない。
|