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,434 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: tech-writer
|
|
3
|
+
description: >-
|
|
4
|
+
Helps structure and polish technical documents of many doctypes (README,
|
|
5
|
+
design docs/ADRs, API reference, PR/commit/issue text, release notes,
|
|
6
|
+
user manuals, docstrings, requirements, test plans, runbooks, threat
|
|
7
|
+
models, proposals, Blueprints, White Papers, RFI/RFP, Qiita/Zenn
|
|
8
|
+
articles — see the skill body for the full list). Use for requests like
|
|
9
|
+
"write a README", "draft a design doc", "write this PR description",
|
|
10
|
+
"write API docs", or Japanese equivalents such as
|
|
11
|
+
「READMEを書いて」「設計ドキュメントを作って」「PRの説明文を書いて」
|
|
12
|
+
(詳細なドキュメント種別とトリガー例はスキル本文を参照). Especially useful
|
|
13
|
+
for a bare goal without enough context (e.g. "I want to write a README" /
|
|
14
|
+
"○○を書きたい"), since this skill drives a one question-at-a-time intake
|
|
15
|
+
before writing. Supports Japanese and English documents, Japanese as the
|
|
16
|
+
primary target. Owns document structure, completeness, and reader fit;
|
|
17
|
+
for living Japanese documents it invokes the bundled `japanese-prose`
|
|
18
|
+
skill for sentence-level naturalness.
|
|
19
|
+
license: MIT
|
|
20
|
+
argument-hint: "[write|review|score] [doctype] <target file or request>"
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
# tech-writer
|
|
24
|
+
|
|
25
|
+
Structures technical documents so readers reach the information they need
|
|
26
|
+
with the shortest path. Covers README, design docs/ADRs, API reference, PR
|
|
27
|
+
descriptions/commit messages/issue reports, release notes/CHANGELOG, user
|
|
28
|
+
manuals/how-to guides, code comments/docstrings, requirements definitions,
|
|
29
|
+
system designs, test plans, operations runbooks, migration plans, security
|
|
30
|
+
designs/threat models, technical proposals, Blueprints, White Papers,
|
|
31
|
+
RFI/RFP procurement documents, and Qiita/Zenn articles.
|
|
32
|
+
|
|
33
|
+
## Trigger phrases / 起動フレーズ
|
|
34
|
+
|
|
35
|
+
English: "write a README", "draft a design doc", "define system
|
|
36
|
+
requirements", "write a system design", "create a test plan", "write an
|
|
37
|
+
operations runbook", "plan a migration", "create a threat model", "write a
|
|
38
|
+
technical proposal", "create a Blueprint", "write a White Paper", "draft an
|
|
39
|
+
RFI", "create an RFP", "write this PR description", "clean up my commit
|
|
40
|
+
message", "make this how-to guide clearer", "write API docs", "summarize
|
|
41
|
+
the release notes", "write a Zenn article", "write this up for Qiita".
|
|
42
|
+
|
|
43
|
+
Japanese: 「READMEを書いて」「設計ドキュメントを作って」
|
|
44
|
+
「要件定義書を作って」「システム設計書を書いて」「テスト計画書を作って」
|
|
45
|
+
「運用設計書を書いて」「移行計画を作って」「脅威モデルを作って」
|
|
46
|
+
「技術提案書を書いて」「Blueprintを作って」「ホワイトペーパーを書いて」
|
|
47
|
+
「RFIを作って」「RFPを作って」「PRの説明文を書いて」
|
|
48
|
+
「コミットメッセージを整えて」「手順書を分かりやすくして」
|
|
49
|
+
「APIドキュメントを整備して」「リリースノートをまとめて」
|
|
50
|
+
「Zennの記事を書いて」「Qiitaに投稿する記事を書いて」。
|
|
51
|
+
|
|
52
|
+
Default format: Markdown for every doctype in this skill, except a git
|
|
53
|
+
commit message body (plain text by convention — light "-" bullets are
|
|
54
|
+
fine, but don't add Markdown headings or fenced code there) and code
|
|
55
|
+
comments/docstrings (the target programming language's own comment/
|
|
56
|
+
docstring syntax). Qiita and Zenn use Markdown with a platform-specific
|
|
57
|
+
YAML frontmatter and a few platform extensions on top — see their doctype
|
|
58
|
+
reference files.
|
|
59
|
+
|
|
60
|
+
## Division of labor
|
|
61
|
+
|
|
62
|
+
Document creation can span three layers: "is the reasoning defensible", "is
|
|
63
|
+
the structure right", and "is the prose natural and readable". The bundled
|
|
64
|
+
`consulting-analyst` skill owns problem decomposition, hypotheses, evidence,
|
|
65
|
+
option evaluation, and synthesis when those are not yet settled. This skill
|
|
66
|
+
owns structure, document type conventions, completeness, and reader fit. The
|
|
67
|
+
bundled `japanese-prose` skill owns sentence-level naturalness, reading load,
|
|
68
|
+
terminology, and repeated-pattern analysis.
|
|
69
|
+
|
|
70
|
+
When a request for a Blueprint, White Paper, proposal, or decision document
|
|
71
|
+
still lacks a defensible analysis, load the sibling `consulting-analyst`
|
|
72
|
+
skill first and consume its `synthesis-handoff.md`. Do not silently invent
|
|
73
|
+
the missing analysis inside document prose. If the sibling skill is absent,
|
|
74
|
+
ask for the decision question and evidence or label analytical conclusions as
|
|
75
|
+
unverified. Preserve issue, hypothesis, source, evidence, criterion, weight,
|
|
76
|
+
score, confidence, counterevidence, and uncertainty records. Return the work
|
|
77
|
+
to analysis when new evidence, a new decision question, changed criteria, or
|
|
78
|
+
a contradictory conclusion requires analytical judgment.
|
|
79
|
+
|
|
80
|
+
If the handoff status is `Incomplete`, either return the decision-critical
|
|
81
|
+
gaps to `consulting-analyst` or preserve that status, the evidence gaps, the
|
|
82
|
+
confidence, and conditional wording visibly in the document. Never turn an
|
|
83
|
+
incomplete handoff into an unqualified recommendation. Tech-writer then locks
|
|
84
|
+
down the document structure and orchestrates the §5 handoff to
|
|
85
|
+
japanese-prose during `write` mode before the final rubber-duck review.
|
|
86
|
+
|
|
87
|
+
- Rule of thumb: "does removing a heading still make sense?" tests structure
|
|
88
|
+
(this skill's job). "Does the recommendation follow from evidence?" tests
|
|
89
|
+
analysis (`consulting-analyst`). "Does rereading a single sentence change
|
|
90
|
+
its meaning?" tests prose (`japanese-prose`).
|
|
91
|
+
- Code comments/docstrings document code itself, but the same
|
|
92
|
+
structure-and-completeness framing still applies.
|
|
93
|
+
|
|
94
|
+
## Execution modes
|
|
95
|
+
|
|
96
|
+
Infer the mode from the argument or the request:
|
|
97
|
+
|
|
98
|
+
- `write` (default): new document, or restructuring a draft. Runs the full
|
|
99
|
+
§1–§6 workflow, starting with the intake loop in §1 and ending only after
|
|
100
|
+
the rubber-duck review loop has no remaining actionable findings. If an
|
|
101
|
+
independent review cannot run or cannot converge, returns the explicit
|
|
102
|
+
review status required by §6 instead of claiming a clean review. For a
|
|
103
|
+
in-scope Japanese living document, also return the §5 Japanese prose
|
|
104
|
+
optimization status.
|
|
105
|
+
- `review`: structural review of an existing document. Does not rewrite;
|
|
106
|
+
reports the gap against the doctype checklist (§7).
|
|
107
|
+
- `score`: structure-only quick diagnostic. Runs
|
|
108
|
+
`scripts/lint.py --json <file>` and summarizes the findings (no rewrite).
|
|
109
|
+
|
|
110
|
+
If no mode is given, interpret "write/create" requests as `write`,
|
|
111
|
+
"fix/review" requests as `review`, and "how does this look?/diagnose"
|
|
112
|
+
requests as `score`.
|
|
113
|
+
|
|
114
|
+
## 1. Gather context — one question at a time, then act
|
|
115
|
+
|
|
116
|
+
Requests are often bare goals ("I want to write a README", "○○を書きたい")
|
|
117
|
+
without enough context to start. Do not front-load a long questionnaire or
|
|
118
|
+
hand the user a checklist to fill in. Instead:
|
|
119
|
+
|
|
120
|
+
1. **Determine the doctype first**, from the table below. If the request
|
|
121
|
+
itself doesn't make it clear, that ambiguity is your first question. If
|
|
122
|
+
the table maps the request to `pr-commit`, resolve the **subtype** —
|
|
123
|
+
commit message, PR description, bug report, or feature request — as
|
|
124
|
+
part of this same first question: `references/doctypes/pr-commit.md`
|
|
125
|
+
gives each a different skeleton and different musts, so don't proceed
|
|
126
|
+
past this doctype without knowing which one applies. Similarly, a bare
|
|
127
|
+
"write a tech blog post" request doesn't by itself say Qiita, Zenn, or
|
|
128
|
+
neither — ask which platform (or "no platform, just a plain document")
|
|
129
|
+
as part of this same first question. For a "technical proposal", ask
|
|
130
|
+
whether it is an internal approval proposal or a supplier response to an
|
|
131
|
+
RFP; only the internal approval proposal maps to `technical-proposal`.
|
|
132
|
+
For a supplier response, structure the document against the supplied
|
|
133
|
+
RFP's requirement IDs, requested proposal contents, pricing format, and
|
|
134
|
+
contract deviations, then apply the general principles in
|
|
135
|
+
`references/style-constitution.md`. For a bare "Blueprint" request, ask
|
|
136
|
+
whether the reader needs an integrated future state and transformation
|
|
137
|
+
path (`blueprint`), implementation-level system detail (`system-design`),
|
|
138
|
+
or approval for one investment (`technical-proposal`). For a bare "White
|
|
139
|
+
Paper" request, ask whether the goal is an evidence-led publication
|
|
140
|
+
(`white-paper`) or an internal approval request (`technical-proposal`);
|
|
141
|
+
do not treat a sales brochure as an evidence-led White Paper.
|
|
142
|
+
2. Open the matching reference file and note its target reader and any
|
|
143
|
+
"settle before writing" items. Combined with the general musts below,
|
|
144
|
+
this is your information checklist — but never show it to the user as a
|
|
145
|
+
form.
|
|
146
|
+
3. **Ask exactly one question at a time**: pick the single most
|
|
147
|
+
information-gaining missing item, ask only that, and wait for the
|
|
148
|
+
answer before asking the next one. Never batch multiple questions into
|
|
149
|
+
one message.
|
|
150
|
+
4. Stop asking once you have, at minimum: (a) the reader, (b) the
|
|
151
|
+
one-sentence outcome the reader should reach after reading, (c) the
|
|
152
|
+
doctype (and subtype, for `pr-commit`), and (d) any doctype-specific
|
|
153
|
+
musts (e.g. the decision and alternatives for a design doc, the
|
|
154
|
+
prior-knowledge floor for a user manual, breaking-change status for
|
|
155
|
+
release notes, the related issue for a PR description or bug report,
|
|
156
|
+
measurable acceptance conditions for a requirements definition, the
|
|
157
|
+
approved requirements baseline for a system design, exit criteria for a
|
|
158
|
+
test plan, RTO/RPO for an operations runbook, rollback conditions for a
|
|
159
|
+
migration plan, assets and trust boundaries for a threat model, market
|
|
160
|
+
unknowns for an RFI, evaluation rules for an RFP, planning horizon,
|
|
161
|
+
approval authority, and baseline evidence for a Blueprint, or the central
|
|
162
|
+
claim, evidence standard, and publisher or sponsor conflicts for a White
|
|
163
|
+
Paper).
|
|
164
|
+
5. **A "don't know" / "not applicable" / "no ticket for this" answer
|
|
165
|
+
satisfies a must — it is not a reason to keep asking.** Ask that must
|
|
166
|
+
at most once; if the answer is a non-answer, record it as a stated
|
|
167
|
+
assumption or an open question inside the document itself (design docs
|
|
168
|
+
already have an Open Questions section for this; for others, add a
|
|
169
|
+
one-line note) and move on.
|
|
170
|
+
6. **Once complete, do not ask the user to compose anything.** Synthesize
|
|
171
|
+
the gathered answers into the best possible generation approach yourself
|
|
172
|
+
and immediately continue into §2–§6 in the same turn to produce the
|
|
173
|
+
document. Skip further confirmation unless the doctype is release-facing
|
|
174
|
+
and consequential (e.g. a public release note with breaking changes) or
|
|
175
|
+
the user explicitly asked to see a plan first.
|
|
176
|
+
7. If the user already volunteered some of this information in the initial
|
|
177
|
+
request, skip the corresponding question — don't re-ask what's already
|
|
178
|
+
known.
|
|
179
|
+
|
|
180
|
+
| Request | doctype | reference file |
|
|
181
|
+
|---|---|---|
|
|
182
|
+
| README / project overview | readme | `references/doctypes/readme.md` |
|
|
183
|
+
| Design doc / ADR / RFC | design-doc | `references/doctypes/design-doc.md` |
|
|
184
|
+
| API reference | api-docs | `references/doctypes/api-docs.md` |
|
|
185
|
+
| PR description / commit message / issue report | pr-commit | `references/doctypes/pr-commit.md` |
|
|
186
|
+
| Release notes / CHANGELOG | release-notes | `references/doctypes/release-notes.md` |
|
|
187
|
+
| User manual / how-to guide / tutorial | user-manual | `references/doctypes/user-manual.md` |
|
|
188
|
+
| Code comments / docstrings | code-comments | `references/doctypes/code-comments.md` |
|
|
189
|
+
| Requirements definition / 要件定義書 | requirements-definition | `references/doctypes/requirements-definition.md` |
|
|
190
|
+
| System design / システム設計書 | system-design | `references/doctypes/system-design.md` |
|
|
191
|
+
| Test plan / テスト計画書 | test-plan | `references/doctypes/test-plan.md` |
|
|
192
|
+
| Operations design / Runbook / 運用設計書 | operations-runbook | `references/doctypes/operations-runbook.md` |
|
|
193
|
+
| Migration plan / 移行計画書 | migration-plan | `references/doctypes/migration-plan.md` |
|
|
194
|
+
| Security design / Threat model / セキュリティ設計書 | security-design | `references/doctypes/security-design.md` |
|
|
195
|
+
| Internal technical proposal | technical-proposal | `references/doctypes/technical-proposal.md` |
|
|
196
|
+
| Blueprint / 将来構想・変革設計図 | blueprint | `references/doctypes/blueprint.md` |
|
|
197
|
+
| White Paper / ホワイトペーパー | white-paper | `references/doctypes/white-paper.md` |
|
|
198
|
+
| Request for information / RFI | rfi | `references/doctypes/rfi.md` |
|
|
199
|
+
| Request for proposal / RFP | rfp | `references/doctypes/rfp.md` |
|
|
200
|
+
| Zenn article | zenn | `references/doctypes/zenn.md` |
|
|
201
|
+
| Qiita article | qiita | `references/doctypes/qiita.md` |
|
|
202
|
+
|
|
203
|
+
For technical documents that don't fit any of these, apply only the general
|
|
204
|
+
principles in `references/style-constitution.md`, using the same
|
|
205
|
+
one-question-at-a-time intake for reader and outcome.
|
|
206
|
+
|
|
207
|
+
## 2. Outline first for long documents
|
|
208
|
+
|
|
209
|
+
For documents likely to run long — design docs/ADRs, user manuals with
|
|
210
|
+
multiple steps, API references covering several endpoints, requirements
|
|
211
|
+
definitions, system designs, test plans, operations runbooks, migration
|
|
212
|
+
plans, security designs, technical proposals, Blueprints, White Papers,
|
|
213
|
+
RFI/RFP documents, or anything the user calls
|
|
214
|
+
"long"/"detailed"/"comprehensive" — draft a table of contents (heading
|
|
215
|
+
outline) before writing any body prose.
|
|
216
|
+
|
|
217
|
+
1. Build the heading outline from the reader and outcome gathered in §1 and
|
|
218
|
+
the doctype's recommended skeleton (in its reference file).
|
|
219
|
+
2. **Review the outline from the reader's point of view before writing
|
|
220
|
+
further**: read only the headings, in order, as the reader identified in
|
|
221
|
+
§1 would. Check whether they can predict what they'll learn from each
|
|
222
|
+
section, whether the order matches how they'd naturally look for that
|
|
223
|
+
information, and whether following the outline gets them to the
|
|
224
|
+
§1 outcome. Reorder, merge, or split headings if not — this is cheaper
|
|
225
|
+
to fix in outline form than after the prose is written.
|
|
226
|
+
3. Only once the outline holds up under that reader-perspective read-through
|
|
227
|
+
should you write the body, section by section.
|
|
228
|
+
|
|
229
|
+
Skip this step for inherently short, atomic artifacts (a single commit
|
|
230
|
+
message, a short PR description, one new entry appended to an existing
|
|
231
|
+
release-notes/CHANGELOG file, a code comment/docstring) and draft directly
|
|
232
|
+
under §3 — see the scope note at the top of
|
|
233
|
+
`references/style-constitution.md`. This exception is about a single
|
|
234
|
+
*entry*, not the release-notes/CHANGELOG document as a whole: a CHANGELOG
|
|
235
|
+
being drafted or restructured from scratch is still a living, multi-section
|
|
236
|
+
document and needs the outline step below.
|
|
237
|
+
|
|
238
|
+
## 3. Write — under the structure constitution
|
|
239
|
+
|
|
240
|
+
For living, multi-section documents (README, design doc, API reference,
|
|
241
|
+
release notes, user manual, requirements definition, system design, test
|
|
242
|
+
plan, operations runbook, migration plan, security design, technical
|
|
243
|
+
proposal, Blueprint, White Paper, RFI/RFP, Zenn/Qiita article), write under
|
|
244
|
+
the 8 rules
|
|
245
|
+
in `references/style-constitution.md`. Summary: state "what this is" and
|
|
246
|
+
"the outcome for the reader" in the first three lines; make headings
|
|
247
|
+
labels that preview content (not "Overview", but "Overview of what");
|
|
248
|
+
order steps as executed and put prerequisites before the steps; one
|
|
249
|
+
action per numbered step; put a concrete example or number right after
|
|
250
|
+
any abstract term; keep code examples minimal and runnable, marking
|
|
251
|
+
omissions explicitly; disclose known limitations and unsupported cases
|
|
252
|
+
instead of hiding them; and keep a last-updated date or target version
|
|
253
|
+
where staleness is a real risk. For Zenn/Qiita, rule 1's "first three
|
|
254
|
+
lines" maps to the frontmatter `title` plus the lead paragraph right
|
|
255
|
+
after it. Zenn body sections start at `##`; Qiita body sections start at
|
|
256
|
+
`#` and use `##` for subsections.
|
|
257
|
+
|
|
258
|
+
For every Markdown doctype, surround `**strong emphasis**` with half-width
|
|
259
|
+
spaces when the delimiters would otherwise touch prose. For example, write
|
|
260
|
+
`これは **強調** になる`, not `これは**強調**にならない`. Spaces are not
|
|
261
|
+
required at line boundaries or next to punctuation, and must not be placed
|
|
262
|
+
inside the `**` delimiters. Use ASCII spaces (`U+0020`), never full-width
|
|
263
|
+
spaces (`U+3000`), tabs, or non-breaking spaces, immediately before and after
|
|
264
|
+
emphasis embedded in prose. Write `これは **「重要」** と説明する`, not
|
|
265
|
+
`これは **「重要」** と説明する`.
|
|
266
|
+
|
|
267
|
+
For atomic artifacts (commit messages, PR descriptions, issue reports,
|
|
268
|
+
code comments/docstrings, a single entry appended to an existing
|
|
269
|
+
release-notes/CHANGELOG file), follow their own skeleton in
|
|
270
|
+
`references/doctypes/pr-commit.md`, `references/doctypes/code-comments.md`,
|
|
271
|
+
or `references/doctypes/release-notes.md` instead — see the scope note in
|
|
272
|
+
`references/style-constitution.md` for why the 8 rules don't apply
|
|
273
|
+
verbatim there.
|
|
274
|
+
|
|
275
|
+
Sentence-level concerns — keeping individual sentences concise, avoiding
|
|
276
|
+
double negatives, not dropping the subject, and general naturalness — belong
|
|
277
|
+
to a prose-polishing skill. In `write` mode for a Japanese document, perform
|
|
278
|
+
the explicit handoff in §5 after the structure is complete. If no compatible
|
|
279
|
+
optimizer is available, still apply ordinary careful-writing judgment and
|
|
280
|
+
report the missing optimization pass explicitly.
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
## 4. Review — structural check
|
|
284
|
+
|
|
285
|
+
After writing, work through the following in order. For atomic artifacts
|
|
286
|
+
(commit message, PR description, issue report, code comment/docstring, a
|
|
287
|
+
single appended release-notes entry), steps 1 and 4 collapse into simply
|
|
288
|
+
re-reading the short artifact against its own doctype skeleton — treat
|
|
289
|
+
step 2 as the primary check for those.
|
|
290
|
+
|
|
291
|
+
1. **Skeleton read-through, from the reader's seat**: extract just the
|
|
292
|
+
headings and the first sentence of each section, and re-read them as the
|
|
293
|
+
§1 reader would — not as the author. Confirm the argument holds together
|
|
294
|
+
and nothing assumes knowledge that reader doesn't have yet. If not,
|
|
295
|
+
revisit how the headings are structured (for long documents, this is the
|
|
296
|
+
same lens as the §2 outline review, now applied to the finished prose).
|
|
297
|
+
2. **Doctype checklist**: compare against the checklist at the end of the
|
|
298
|
+
matching reference file.
|
|
299
|
+
3. **Structural lint**: where possible, run `uv run scripts/lint.py <file>`
|
|
300
|
+
(add `--atomic` for a commit message, PR description, issue report,
|
|
301
|
+
code comment/docstring, or a single release-notes entry) to
|
|
302
|
+
mechanically catch heading-level skips, code blocks missing a
|
|
303
|
+
language tag, leftover placeholders, suspicious links, and strong-emphasis
|
|
304
|
+
delimiters that directly touch prose. Findings are flags, not mandates —
|
|
305
|
+
deliberate exceptions can stay; note the reason briefly.
|
|
306
|
+
4. **Reader-goal recheck**: confirm the "what the reader can do after
|
|
307
|
+
reading" outcome from §1 is actually achievable from this document alone.
|
|
308
|
+
|
|
309
|
+
## 5. Optimize Japanese prose without changing the structure — write mode only
|
|
310
|
+
|
|
311
|
+
For a living, multi-section document whose requested final language is
|
|
312
|
+
Japanese, read `references/japanese-prose-optimization.md` and hand the
|
|
313
|
+
completed draft to kotonoha's bundled `japanese-prose` skill. This pass is
|
|
314
|
+
mandatory for an in-scope document.
|
|
315
|
+
|
|
316
|
+
Load `japanese-prose` through the host's skill-loading mechanism. When only
|
|
317
|
+
installed skill files are exposed, resolve the sibling path
|
|
318
|
+
`<tech-writer-dir>/../japanese-prose/SKILL.md` first, then check
|
|
319
|
+
`.github/skills/japanese-prose/SKILL.md`,
|
|
320
|
+
`.copilot/skills/japanese-prose/SKILL.md`, and
|
|
321
|
+
`$HOME/.copilot/skills/japanese-prose/SKILL.md`. Load the discovered
|
|
322
|
+
`SKILL.md` and follow its quick or full workflow. A standard
|
|
323
|
+
`npx kotonoha install` installs this sibling skill automatically. Treat the
|
|
324
|
+
pass as unavailable only when someone copied or installed tech-writer without
|
|
325
|
+
its bundled sibling, or when the optimizer cannot start.
|
|
326
|
+
|
|
327
|
+
Freeze heading hierarchy, section order, identifiers, numeric facts,
|
|
328
|
+
citations, normative language, tables, code, commands, acceptance criteria,
|
|
329
|
+
and explicit risks before handoff. Require sentence-level optimization and
|
|
330
|
+
request AI-pattern diagnostics, reading-load review, and terminology checks
|
|
331
|
+
when their scripts are runnable, without changing those invariants. Missing
|
|
332
|
+
optional diagnostics are a reported limitation, not proof that the prose pass
|
|
333
|
+
did not run. After the prose pass, repeat the doctype checklist and structural
|
|
334
|
+
lint from §4.
|
|
335
|
+
|
|
336
|
+
For an in-scope Japanese document in `write` mode, report one explicit status.
|
|
337
|
+
Do not run this pass or report a status for atomic artifacts such as commit
|
|
338
|
+
messages, PR descriptions, issue reports, single release-note entries, or
|
|
339
|
+
code comments/docstrings unless the user explicitly requests prose polishing
|
|
340
|
+
and supplies the prose in a standalone file:
|
|
341
|
+
|
|
342
|
+
- `Japanese prose optimization completed`
|
|
343
|
+
- `Japanese prose optimization not performed`
|
|
344
|
+
- `Japanese prose optimization did not converge`
|
|
345
|
+
|
|
346
|
+
Across the complete write workflow, allow at most 15 optimizer handoffs,
|
|
347
|
+
including reruns after rubber-duck edits. If no compatible optimizer can be
|
|
348
|
+
loaded, use
|
|
349
|
+
`Japanese prose optimization not performed` and state the reason. If the
|
|
350
|
+
optimizer starts but fails, or an edit violates a frozen invariant, revert
|
|
351
|
+
the invalid edit and retry within the three-round limit; unresolved failures
|
|
352
|
+
or invariant violations use
|
|
353
|
+
`Japanese prose optimization did not converge`. Do not claim this
|
|
354
|
+
optimization from kotonoha's structural lint alone. Documents that are not
|
|
355
|
+
within the Japanese final-language scope defined above require no optimization
|
|
356
|
+
status.
|
|
357
|
+
|
|
358
|
+
## 6. Rubber-duck review loop — write mode only
|
|
359
|
+
|
|
360
|
+
After the structural review in §4 and any Japanese prose optimization in §5,
|
|
361
|
+
use the host's subagent mechanism to
|
|
362
|
+
launch an independent reviewer in the `rubber-duck` role to challenge the
|
|
363
|
+
completed document for meaningful problems that the authoring pass may have
|
|
364
|
+
missed. Prefer a registered `rubber-duck` agent when the host provides one;
|
|
365
|
+
otherwise use an independent general-purpose or critic-style subagent with
|
|
366
|
+
the same review prompt. Treat the reviewer as unavailable only when the host
|
|
367
|
+
has no independent subagent mechanism. Do not substitute the author's own
|
|
368
|
+
self-review: independence is the point of this pass. This loop is mandatory
|
|
369
|
+
for `write` mode; do not run it for `review` or `score` mode.
|
|
370
|
+
|
|
371
|
+
1. **Start the review with full context**: give the reviewer the target file,
|
|
372
|
+
doctype, intended reader, one-sentence reader outcome from §1, and any
|
|
373
|
+
explicit constraints or assumptions. Ask it to report concrete,
|
|
374
|
+
actionable problems in correctness, logic, missing information, reader
|
|
375
|
+
flow, examples, and stated limitations — not cosmetic preferences.
|
|
376
|
+
2. **Resolve every valid finding**: edit the document rather than merely
|
|
377
|
+
listing proposed fixes. If a finding conflicts with a stated requirement
|
|
378
|
+
or is factually inapplicable, record a one-line reason for declining it.
|
|
379
|
+
3. **Re-run the relevant checks after each edit round**: if a fix changed
|
|
380
|
+
Japanese prose, repeat the §5 optimization over the changed prose before
|
|
381
|
+
reporting its final status. Then repeat the doctype checklist and
|
|
382
|
+
structural lint from §4 before asking for another rubber-duck review. A
|
|
383
|
+
fix must not introduce a new structural defect or leave the final Japanese
|
|
384
|
+
prose outside the completed optimization pass. If a required rerun cannot
|
|
385
|
+
start because all 15 handoffs were already used, or cannot complete,
|
|
386
|
+
report `Japanese prose optimization did not converge`, not `completed`.
|
|
387
|
+
4. **Review again with the prior decisions**: reuse the same reviewer context
|
|
388
|
+
when supported. Otherwise, include the previous findings, applied fixes,
|
|
389
|
+
and declined findings with their reasons in every new review prompt. Ask
|
|
390
|
+
specifically for unresolved or newly introduced actionable findings.
|
|
391
|
+
5. **Use a bounded convergence rule**: allow at most five rubber-duck rounds
|
|
392
|
+
for a living, multi-section document. For an atomic artifact, run one
|
|
393
|
+
round and finish immediately if it is clean; only continue after an
|
|
394
|
+
actionable finding, with a maximum of three rounds. A round is clean only
|
|
395
|
+
when no unaddressed actionable correctness, logic, completeness,
|
|
396
|
+
reader-flow, example, or limitation findings remain. A finding declined
|
|
397
|
+
with a recorded requirement-based or factual reason is a resolved
|
|
398
|
+
exception rather than an open finding. If another round runs, supply that
|
|
399
|
+
exception back to the reviewer under step 4. Purely cosmetic preferences
|
|
400
|
+
are not actionable.
|
|
401
|
+
6. **Report non-clean outcomes precisely**: if the host has no independent
|
|
402
|
+
reviewer, label the result `review not performed` and do not claim the
|
|
403
|
+
rubber-duck pass completed. If the round limit is reached with
|
|
404
|
+
unaddressed actionable findings, or findings oscillate between
|
|
405
|
+
contradictory requirements, label it `review did not converge` and
|
|
406
|
+
include the latest unresolved findings and fixes already attempted.
|
|
407
|
+
|
|
408
|
+
## 7. Doctype checklist summary
|
|
409
|
+
|
|
410
|
+
See each reference file for detail. The items below are for living,
|
|
411
|
+
multi-section documents (README, design doc, API reference, release notes,
|
|
412
|
+
user manual, requirements definition, system design, test plan, operations
|
|
413
|
+
runbook, migration plan, security design, technical proposal, Blueprint,
|
|
414
|
+
White Paper, RFI/RFP, Zenn/Qiita article). Atomic
|
|
415
|
+
artifacts (commit message, PR
|
|
416
|
+
description, issue report, code comment/docstring, a single appended
|
|
417
|
+
release-notes entry) are already covered by their own doctype checklist
|
|
418
|
+
via step 2 in §4 — these common items don't add extra requirements on top
|
|
419
|
+
of that. Common items to confirm:
|
|
420
|
+
|
|
421
|
+
- Do the first three lines convey the purpose and target reader?
|
|
422
|
+
- Does reading only the headings trace the whole document's flow?
|
|
423
|
+
- Are prerequisites/dependencies stated before the usage steps?
|
|
424
|
+
- Can code/command examples be copied and run as-is?
|
|
425
|
+
- Are known limitations/unsupported cases/caveats stated, not omitted?
|
|
426
|
+
- Where staleness is a real risk, is the version/last-updated date/target
|
|
427
|
+
branch stated?
|
|
428
|
+
|
|
429
|
+
## Acknowledgment
|
|
430
|
+
|
|
431
|
+
The bundled prose optimizer is an original kotonoha implementation built on
|
|
432
|
+
[GiNZA](https://github.com/megagonlabs/ginza) (MIT License). Tech-writer owns
|
|
433
|
+
technical-document structure while japanese-prose uses GiNZA's morphology,
|
|
434
|
+
dependency, and named-entity analysis for sentence-level review.
|
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
# <Blueprint名>
|
|
2
|
+
|
|
3
|
+
<対象読者、実現する将来像、この文書を使って合意する事項を3文以内で記載する。>
|
|
4
|
+
|
|
5
|
+
- オーナー: <組織・役割>
|
|
6
|
+
- 作成日: <YYYY-MM-DD>
|
|
7
|
+
- 最終更新日: <YYYY-MM-DD>
|
|
8
|
+
- 対象期間: <YYYY-MM-DD〜YYYY-MM-DD、または3年間など>
|
|
9
|
+
- 対象範囲: <事業・組織・業務・データ・技術など>
|
|
10
|
+
- ステータス: Draft / In Review / Approved / Rejected / Deferred / Superseded
|
|
11
|
+
- 承認者・会議体: <名称>
|
|
12
|
+
- 現行版: <版番号>
|
|
13
|
+
- 置き換える文書: <文書名・版、または該当なし>
|
|
14
|
+
- Analysis status: Completed / Incomplete / Not performed
|
|
15
|
+
- Evidence gaps: <不足する証拠、影響する判断、収集担当・期限、またはなし>
|
|
16
|
+
- 分析ハンドオフ: <synthesis-handoff.mdの所在、またはなし>
|
|
17
|
+
|
|
18
|
+
`Analysis status`は文書の承認ステータスとは別に記録する。`Incomplete`の場合は、不足する証拠と確からしさを明示し、影響する結論・推奨事項を条件付きで記載する。判断を妨げる不足は`consulting-analyst`へ戻すか、この文書に残す。`Not performed`の場合は、分析未実施の範囲と理由を記載し、分析済みとして扱わない。
|
|
19
|
+
|
|
20
|
+
## <このBlueprintで実現する成果>
|
|
21
|
+
|
|
22
|
+
<対象期間の終了時に、誰が何を実現できる状態になるかを記載する。>
|
|
23
|
+
|
|
24
|
+
| 成果ID | 期待する成果 | 現状値 | 目標値 | 測定方法 | 判定時期 | オーナー |
|
|
25
|
+
|---|---|---:|---:|---|---|---|
|
|
26
|
+
| OUT-001 | <成果> | <値> | <値> | <方法> | <時期> | <役割> |
|
|
27
|
+
|
|
28
|
+
## 対象範囲と対象外
|
|
29
|
+
|
|
30
|
+
### 対象範囲
|
|
31
|
+
|
|
32
|
+
- <対象となる組織、能力、業務、データ、システム、地域>
|
|
33
|
+
|
|
34
|
+
### 対象外
|
|
35
|
+
|
|
36
|
+
- <このBlueprintでは扱わない事項と、その扱い先>
|
|
37
|
+
|
|
38
|
+
### 前提条件と制約
|
|
39
|
+
|
|
40
|
+
| ID | 種別 | 内容 | 根拠 | 変更時の影響 |
|
|
41
|
+
|---|---|---|---|---|
|
|
42
|
+
| CON-001 | 前提 / 制約 | <内容> | <資料・決定> | <影響> |
|
|
43
|
+
|
|
44
|
+
## 変革を必要とする背景
|
|
45
|
+
|
|
46
|
+
<外部環境、利用者ニーズ、経営課題、技術的負債、規制など、将来像が必要な理由を事実と解釈に分けて記載する。>
|
|
47
|
+
|
|
48
|
+
| ドライバーID | ドライバー | 根拠 | 対応しない場合の影響 |
|
|
49
|
+
|---|---|---|---|
|
|
50
|
+
| DRV-001 | <変化・課題> | <データ・資料> | <影響> |
|
|
51
|
+
|
|
52
|
+
## 設計原則
|
|
53
|
+
|
|
54
|
+
| 原則ID | 原則 | 判断への適用方法 | 例外を認める条件 |
|
|
55
|
+
|---|---|---|---|
|
|
56
|
+
| PRN-001 | <原則> | <選択・優先順位への反映> | <条件と承認者> |
|
|
57
|
+
|
|
58
|
+
## 現在地を示すベースライン
|
|
59
|
+
|
|
60
|
+
### 現在の能力と成熟度
|
|
61
|
+
|
|
62
|
+
| 能力ID | 能力 | 現状 | 成熟度 | 根拠 | 主な課題 |
|
|
63
|
+
|---|---|---|---|---|---|
|
|
64
|
+
| CAP-001 | <能力> | <現在の状態> | 1〜5 | <評価資料> | <課題> |
|
|
65
|
+
|
|
66
|
+
### 現在の構成
|
|
67
|
+
|
|
68
|
+
<業務、組織、データ、アプリケーション、基盤、セキュリティ、運用のうち、対象範囲に必要な現在の構成を示す。>
|
|
69
|
+
|
|
70
|
+
```mermaid
|
|
71
|
+
flowchart LR
|
|
72
|
+
A[<現在の利用者・業務>] --> B[<現在の能力・システム>]
|
|
73
|
+
B --> C[<現在の成果・制約>]
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## 目標とする能力と将来像
|
|
77
|
+
|
|
78
|
+
### 目標能力
|
|
79
|
+
|
|
80
|
+
| 能力ID | 目標能力 | 提供する価値 | 対象者 | 成熟度目標 | 成功条件 |
|
|
81
|
+
|---|---|---|---|---|---|
|
|
82
|
+
| CAP-001 | <能力> | <価値> | <対象者> | 1〜5 | <測定可能な条件> |
|
|
83
|
+
|
|
84
|
+
### 将来のOperating Model
|
|
85
|
+
|
|
86
|
+
| 観点 | 将来の状態 | 主な変更 | 意思決定者 |
|
|
87
|
+
|---|---|---|---|
|
|
88
|
+
| 組織・役割 | <状態> | <変更> | <役割> |
|
|
89
|
+
| 業務プロセス | <状態> | <変更> | <役割> |
|
|
90
|
+
| ガバナンス | <状態> | <変更> | <役割> |
|
|
91
|
+
| 人材・スキル | <状態> | <変更> | <役割> |
|
|
92
|
+
|
|
93
|
+
### 将来のデータ・技術構成
|
|
94
|
+
|
|
95
|
+
<技術が対象外の場合は、その理由と別文書を記載する。>
|
|
96
|
+
|
|
97
|
+
```mermaid
|
|
98
|
+
flowchart LR
|
|
99
|
+
A[<利用者・チャネル>] --> B[<目標能力>]
|
|
100
|
+
B --> C[<データ・サービス・基盤>]
|
|
101
|
+
C --> D[<測定可能な成果>]
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
| 構成要素 | 責任 | 原則・標準 | 詳細設計の所在 |
|
|
105
|
+
|---|---|---|---|
|
|
106
|
+
| <要素> | <責任> | <適用する原則> | <文書・未作成> |
|
|
107
|
+
|
|
108
|
+
### セキュリティ・リスク・運用の将来像
|
|
109
|
+
|
|
110
|
+
- セキュリティ: <信頼境界、責任分担、主要統制>
|
|
111
|
+
- リスク管理: <識別、受容、軽減、報告の方法>
|
|
112
|
+
- 運用: <所有権、監視、継続性、改善サイクル>
|
|
113
|
+
|
|
114
|
+
## 現在地と将来像の差分
|
|
115
|
+
|
|
116
|
+
| Gap ID | 関連能力 | 現在地 | 将来像 | 必要な変更 | 優先度 |
|
|
117
|
+
|---|---|---|---|---|---|
|
|
118
|
+
| GAP-001 | CAP-001 | <状態> | <状態> | <変更> | High / Medium / Low |
|
|
119
|
+
|
|
120
|
+
## 変革ワークストリーム
|
|
121
|
+
|
|
122
|
+
| WS ID | ワークストリーム | 解消するGap | 成果物 | オーナー | 依存関係 | 完了条件 |
|
|
123
|
+
|---|---|---|---|---|---|---|
|
|
124
|
+
| WS-001 | <名称> | GAP-001 | <成果物> | <役割> | <WS・外部条件> | <条件> |
|
|
125
|
+
|
|
126
|
+
## 移行段階とロードマップ
|
|
127
|
+
|
|
128
|
+
<日付だけでなく、各段階へ進む条件と完了条件を記載する。>
|
|
129
|
+
|
|
130
|
+
| フェーズ | 目的 | 対象ワークストリーム | 開始条件 | 完了条件 | 目標時期 |
|
|
131
|
+
|---|---|---|---|---|---|
|
|
132
|
+
| Phase 1 | <目的> | WS-001 | <条件> | <測定可能な条件> | <時期> |
|
|
133
|
+
|
|
134
|
+
### 移行中の共存と廃止
|
|
135
|
+
|
|
136
|
+
- 共存が必要な状態: <旧新の併存、データ同期、二重運用>
|
|
137
|
+
- 切り替え条件: <判断指標・承認者>
|
|
138
|
+
- 廃止対象と条件: <業務・システム・契約・データ>
|
|
139
|
+
- ロールバックまたは方針見直し条件: <条件>
|
|
140
|
+
|
|
141
|
+
## ガバナンスと意思決定
|
|
142
|
+
|
|
143
|
+
| 判断事項 | 決定者 | 提案者 | 相談先 | 報告先 | 判断時期 |
|
|
144
|
+
|---|---|---|---|---|---|
|
|
145
|
+
| <判断事項> | <役割> | <役割> | <役割> | <役割> | <時期> |
|
|
146
|
+
|
|
147
|
+
### 例外と変更管理
|
|
148
|
+
|
|
149
|
+
- 原則の例外申請: <手順・承認者>
|
|
150
|
+
- Blueprint変更: <提案、影響分析、承認、版管理>
|
|
151
|
+
- 下位文書との不整合: <検出・解消方法>
|
|
152
|
+
|
|
153
|
+
## 成果の測定とレビュー
|
|
154
|
+
|
|
155
|
+
| 指標ID | 関連成果 | 指標 | 目標 | データ源 | 頻度 | 未達時の対応 |
|
|
156
|
+
|---|---|---|---:|---|---|---|
|
|
157
|
+
| KPI-001 | OUT-001 | <指標> | <値> | <データ源> | <頻度> | <見直し・是正> |
|
|
158
|
+
|
|
159
|
+
## リスクと未解決事項
|
|
160
|
+
|
|
161
|
+
| ID | 種別 | 内容 | 影響 | 対応 | オーナー | 期限 |
|
|
162
|
+
|---|---|---|---|---|---|---|
|
|
163
|
+
| RSK-001 | リスク / 未解決事項 | <内容> | <影響> | <対応> | <役割> | <日付> |
|
|
164
|
+
|
|
165
|
+
## トレーサビリティ
|
|
166
|
+
|
|
167
|
+
分析ハンドオフがある場合は、関連するQ / HYP / FND / EVD / GAP / INT / CRT IDsを保持する。INTは介入、CRTは選択肢の評価基準を表す。該当しないリンクは理由付き`N/A`とし、ハンドオフがない場合は分析IDを無理に作らない。
|
|
168
|
+
|
|
169
|
+
| 論点 Q IDs | 仮説 HYP IDs | 発見 FND IDs | 証拠 EVD IDs | ドライバー | 設計原則 | 目標能力 | Gap | 介入 INT IDs | 評価基準 CRT IDs | ワークストリーム | 指標 |
|
|
170
|
+
|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
171
|
+
| <関連Q IDs、またはN/A> | <関連HYP IDs、またはN/A> | <関連FND IDs、またはN/A> | <関連EVD IDs、またはN/A> | DRV-001 | PRN-001 | CAP-001 | GAP-001 | <関連INT IDs、またはN/A> | <関連CRT IDs、またはN/A> | WS-001 | KPI-001 |
|
|
172
|
+
|
|
173
|
+
## 承認と変更履歴
|
|
174
|
+
|
|
175
|
+
### 承認
|
|
176
|
+
|
|
177
|
+
ヘッダーのステータスと、次の承認結果を一致させる。承認結果が`Rejected`または`Deferred`の場合、ステータスを`Approved`にしない。
|
|
178
|
+
|
|
179
|
+
| 役割 | 氏名・会議体 | 判断 | 日付 | 条件 |
|
|
180
|
+
|---|---|---|---|---|
|
|
181
|
+
| <役割> | <名称> | Approved / Rejected / Deferred | <YYYY-MM-DD> | <条件> |
|
|
182
|
+
|
|
183
|
+
### 変更履歴
|
|
184
|
+
|
|
185
|
+
| 版 | 日付 | 変更内容 | 変更者 | 承認者 |
|
|
186
|
+
|---|---|---|---|---|
|
|
187
|
+
| 0.1 | <YYYY-MM-DD> | 初版 | <氏名> | <氏名・会議体> |
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# <Noun phrase naming the decision>
|
|
2
|
+
|
|
3
|
+
<One-paragraph summary: the decision being proposed and why it matters now.>
|
|
4
|
+
|
|
5
|
+
- Status: Proposed / Accepted / Rejected / Superseded
|
|
6
|
+
- Date: <YYYY-MM-DD>
|
|
7
|
+
|
|
8
|
+
## Context
|
|
9
|
+
|
|
10
|
+
<Why this decision is needed now. State facts, not opinion>
|
|
11
|
+
|
|
12
|
+
## Decision
|
|
13
|
+
|
|
14
|
+
<State what was chosen in one sentence, then the details>
|
|
15
|
+
|
|
16
|
+
## Alternatives considered
|
|
17
|
+
|
|
18
|
+
### Option A: <name>
|
|
19
|
+
|
|
20
|
+
<Description and why it was rejected>
|
|
21
|
+
|
|
22
|
+
## Consequences
|
|
23
|
+
|
|
24
|
+
- Gains: <...>
|
|
25
|
+
- Costs / trade-offs accepted: <...>
|
|
26
|
+
|
|
27
|
+
## Open questions
|
|
28
|
+
|
|
29
|
+
- <If any>
|