kotonoha 0.2.0 → 0.4.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/CHANGELOG.md +36 -0
- package/README-ja.md +87 -21
- package/README.md +111 -20
- package/package.json +5 -2
- package/skills/consulting-analyst/SKILL.md +241 -0
- package/skills/consulting-analyst/assets/templates/analysis-brief.md +58 -0
- package/skills/consulting-analyst/assets/templates/decision-analysis.md +62 -0
- package/skills/consulting-analyst/assets/templates/hypothesis-evidence-ledger.md +48 -0
- package/skills/consulting-analyst/assets/templates/issue-tree.md +35 -0
- package/skills/consulting-analyst/assets/templates/synthesis-handoff.md +68 -0
- package/skills/consulting-analyst/references/evidence-and-hypotheses.md +80 -0
- package/skills/consulting-analyst/references/framework-selection.md +84 -0
- package/skills/consulting-analyst/references/handoff-contract.md +90 -0
- package/skills/japanese-prose/NOTICE.md +7 -1
- package/skills/japanese-prose/SKILL.md +48 -16
- package/skills/japanese-prose/references/review-workflow.md +57 -0
- package/skills/japanese-prose/references/scoring.md +6 -0
- package/skills/japanese-prose/scripts/core.py +6 -2
- package/skills/japanese-prose/scripts/invariants.py +182 -0
- package/skills/japanese-prose/scripts/lint.py +68 -3
- package/skills/japanese-prose/scripts/test_engine.py +168 -0
- package/skills/presentation-planner/SKILL.md +14 -0
- package/skills/tech-writer/SKILL.md +58 -24
- package/skills/tech-writer/assets/templates/blueprint.md +187 -0
- package/skills/tech-writer/assets/templates/white-paper.md +192 -0
- package/skills/tech-writer/references/doctypes/blueprint.md +81 -0
- package/skills/tech-writer/references/doctypes/white-paper.md +84 -0
- package/skills/tech-writer/references/japanese-prose-optimization.md +17 -8
- package/skills/tech-writer/references/style-constitution.md +10 -4
- package/skills/tech-writer/scripts/lint.py +10 -5
package/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,42 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
## [0.4.0] - 2026-10-19
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
|
|
14
|
+
- Add duplicate-particle/word, Japanese bracket, and paragraph style-mixing
|
|
15
|
+
diagnostics, plus a minimal-edit `proofread` skill mode.
|
|
16
|
+
- Add a Markdown-aware invariant gate with protected-content checks and
|
|
17
|
+
required hash-bound semantic review of edits.
|
|
18
|
+
|
|
19
|
+
### Fixed
|
|
20
|
+
|
|
21
|
+
- Avoid treating obligation expressions as double-negative errors and
|
|
22
|
+
conclusion questions as formulaic assertions.
|
|
23
|
+
- Keep shorter fence markers and fence-like info strings inside code blocks
|
|
24
|
+
out of prose diagnostics.
|
|
25
|
+
- Require the invariant gate and current semantic review to pass before
|
|
26
|
+
claiming Japanese prose optimization completed.
|
|
27
|
+
|
|
28
|
+
## [0.3.0] - 2026-09-30
|
|
29
|
+
|
|
30
|
+
### Added
|
|
31
|
+
|
|
32
|
+
- Add the `consulting-analyst` skill for issue trees, testable hypotheses,
|
|
33
|
+
evidence discipline, Current–Target–Gap analysis, transparent option
|
|
34
|
+
comparison, Pyramid Principle synthesis, and traceable handoff to writing
|
|
35
|
+
and presentation skills.
|
|
36
|
+
- Add general-purpose Blueprint and White Paper doctypes with Japanese
|
|
37
|
+
templates, intake guidance, responsibility boundaries, traceability,
|
|
38
|
+
evidence controls, and review checklists.
|
|
39
|
+
|
|
40
|
+
### Fixed
|
|
41
|
+
|
|
42
|
+
- Require ASCII half-width spaces immediately before and after Markdown
|
|
43
|
+
strong emphasis embedded in prose, and flag full-width, non-breaking, or
|
|
44
|
+
tab spacing such as `これは **「重要」** と説明する`.
|
|
45
|
+
|
|
10
46
|
## [0.2.0] - 2026-09-29
|
|
11
47
|
|
|
12
48
|
### Changed
|
package/README-ja.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# kotonoha
|
|
2
2
|
|
|
3
|
-
kotonoha
|
|
3
|
+
kotonohaは、コンサルティング分析、技術文書、日本語表現、プレゼンテーション設計を支援するGitHub Copilot CLIスキルを提供します。曖昧な課題の構造化から、文書化、日本語表現の改善、プレゼンテーション設計までを一連の流れとして支援します。
|
|
4
|
+
|
|
5
|
+
`consulting-analyst`は、課題を論点、仮説、証拠、選択肢、提言へ構造化します。分析結果を受け取った`tech-writer`は、README、設計文書、Blueprint、White Paper、提案書などへ内容を落とし込みます。日本語の表現品質は`japanese-prose`がGiNZAベースの診断で改善します。プレゼンテーションが必要な場合は、`presentation-planner`がシナリオ、スライド構成、デザイン仕様、PPTX作成スキル向けの引き継ぎ情報を生成します。
|
|
4
6
|
|
|
5
7
|
[English](./README.md) | [日本語](./README-ja.md)
|
|
6
8
|
|
|
@@ -8,9 +10,9 @@ kotonohaは、技術文書の作成とプレゼンテーション設計を支援
|
|
|
8
10
|
|
|
9
11
|
`kotonoha`は、「言葉」「言語」「和歌」を表す古典的・詩的な表現「言の葉(ことのは)」に由来します。読み手の意図を、明確で構造化された言葉へ育てるという、このプロジェクトの目的を表しています。
|
|
10
12
|
|
|
11
|
-
|
|
13
|
+
『万葉集』との関係には補足が必要です。その書名を「万(よろづ)の言の葉、すなわち数多くの歌」と解釈する伝統的な説がありますが、由来は確定していません。「やまとうたは、人の心を種として、よろづの言の葉とぞなれりける」という有名な表現の直接の典拠は、『万葉集』ではなく紀貫之による[『古今和歌集』仮名序](https://ja.wikisource.org/wiki/%E5%8F%A4%E4%BB%8A%E5%92%8C%E6%AD%8C%E9%9B%86%E4%BB%AE%E5%90%8D%E5%BA%8F)です。
|
|
12
14
|
|
|
13
|
-
|
|
15
|
+
一方、それ以前に成立した『万葉集』でも、言葉が現実に働きかけるという近い思想が「言霊」として詠まれています。奈良県立万葉文化館の「万葉百科」では、山上憶良の[894番歌](https://manyo-hyakka.pref.nara.jp/db/detailLink?cls=db_manyo&pkey=894)や[3254番歌](https://manyo-hyakka.pref.nara.jp/db/detailLink?cls=db_manyo&pkey=3254)で確認できます。「言の葉」の歴史的な語義については、[コトバンク](https://kotobank.jp/word/%E8%A8%80%E3%81%AE%E8%91%89-503155)も参照しています。
|
|
14
16
|
|
|
15
17
|
## tech-writerが解決する課題
|
|
16
18
|
|
|
@@ -20,7 +22,8 @@ kotonohaは文書構造と技術的な不変条件を固定してから日本語
|
|
|
20
22
|
|
|
21
23
|
## 主な機能
|
|
22
24
|
|
|
23
|
-
-
|
|
25
|
+
- Issue Tree、仮説・証拠台帳、Current–Target–Gap、意思決定マトリクス、ピラミッド原則を使った事業・技術課題の構造化
|
|
26
|
+
- README、設計書・ADR、APIリファレンス、PR説明、コミットメッセージ、Issue本文、リリースノート、ユーザーマニュアル、コードコメント、要件定義書、システム設計書、テスト計画書、運用設計書・Runbook、移行計画書、セキュリティ設計書、技術提案書、Blueprint、White Paper、RFI・RFP、Qiita・Zenn記事の作成とレビュー
|
|
24
27
|
- 文書種別ごとの推奨構成とチェックリスト
|
|
25
28
|
- ID、事実、表、コード、受け入れ基準を変更せずに日本語表現を反復的に最適化する、GiNZAベースの独自`japanese-prose`文章診断
|
|
26
29
|
- 文書作成後のrubber-duck reviewと、対応可能な指摘がなくなるまでの修正・再レビュー
|
|
@@ -46,21 +49,47 @@ kotonohaは文書構造と技術的な不変条件を固定してから日本語
|
|
|
46
49
|
| 利用者向け文書 | ユーザーマニュアル、手順書、チュートリアル | `user-manual` |
|
|
47
50
|
| ソースコード文書 | コードコメント、docstring | `code-comments` |
|
|
48
51
|
| 社内向け技術提案 | アーキテクチャ、投資、デリバリー提案 | `technical-proposal` |
|
|
52
|
+
| 将来構想・変革設計図 | 事業、Operating Model、データ、技術のBlueprint | `blueprint` |
|
|
53
|
+
| 証拠に基づく解説・提言 | 技術・事業White Paper | `white-paper` |
|
|
49
54
|
| 情報提供依頼 | RFI | `rfi` |
|
|
50
55
|
| 提案依頼 | RFP | `rfp` |
|
|
51
56
|
| 技術記事 | Zenn記事 | `zenn` |
|
|
52
57
|
| 技術記事 | Qiita記事 | `qiita` |
|
|
53
58
|
|
|
54
|
-
再利用可能なテンプレートには、README、設計判断、ユーザーマニュアル、PR説明があります。要件定義、システム設計、テスト、運用、移行、セキュリティの各文書にも対応しています。技術提案、RFI、RFP、Qiita記事のテンプレートも含まれます。すべての文書種別には、`skills/tech-writer/references/doctypes/`配下に専用の構成ガイドとレビューチェックリストがあります。
|
|
59
|
+
再利用可能なテンプレートには、README、設計判断、ユーザーマニュアル、PR説明があります。要件定義、システム設計、テスト、運用、移行、セキュリティの各文書にも対応しています。技術提案、Blueprint、White Paper、RFI、RFP、Qiita記事のテンプレートも含まれます。すべての文書種別には、`skills/tech-writer/references/doctypes/`配下に専用の構成ガイドとレビューチェックリストがあります。
|
|
60
|
+
|
|
61
|
+
## consulting-analystの機能
|
|
62
|
+
|
|
63
|
+
- 文書やプレゼンテーションを作る前に、意思決定者、意思決定の問い、成果、範囲、証拠不足を定義
|
|
64
|
+
- フレームワークを機械的に埋めず、意思決定に必要な最小構成を選択
|
|
65
|
+
- Issue Treeと検証可能な仮説・証拠台帳を作成
|
|
66
|
+
- Current–Target–Gap分析と、採点基準・感度分析を伴う選択肢比較を実施
|
|
67
|
+
- 事実、推定、前提、解釈、提言を区別
|
|
68
|
+
- `tech-writer`と`presentation-planner`へ、証拠を追跡できる分析結果を引き継ぐ
|
|
69
|
+
|
|
70
|
+
自然言語では、次のように依頼できます。
|
|
71
|
+
|
|
72
|
+
```text
|
|
73
|
+
この事業課題をIssue Treeで構造化し、優先論点ごとに必要な証拠を整理して
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
```text
|
|
77
|
+
現状と目標状態を比較してGapを特定し、Blueprint向けの分析を準備して
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
```text
|
|
81
|
+
複数案を明示的な評価基準で比較し、不足する証拠を捏造せずに
|
|
82
|
+
White Paper向けの分析を作成して
|
|
83
|
+
```
|
|
55
84
|
|
|
56
85
|
## presentation-plannerの機能
|
|
57
86
|
|
|
58
87
|
- 対象者、意思決定、行動喚起、プレゼンテーションの制約を定義
|
|
59
88
|
- ブリーフ、対象者の理解を導くシナリオ、主張型タイトルを使ったスライド構成を生成
|
|
60
|
-
- YAMLデザイン仕様とPPTX
|
|
89
|
+
- YAMLデザイン仕様とPPTX作成スキル向けの再現可能で明確な引き継ぎ情報を生成
|
|
61
90
|
- 経営判断、技術説明、データ報告向けのシナリオテンプレート
|
|
62
91
|
- 経営提案、技術説明、データ報告向けのデザイン仕様
|
|
63
|
-
- `.pptx
|
|
92
|
+
- `.pptx`の生成、バイナリ編集、レンダリング、視覚的な品質確認は専用のPPTXスキルに委ねる
|
|
64
93
|
|
|
65
94
|
## セットアップ
|
|
66
95
|
|
|
@@ -68,11 +97,11 @@ kotonohaは文書構造と技術的な不変条件を固定してから日本語
|
|
|
68
97
|
|
|
69
98
|
- GitHub Copilot CLIがインストールされていること
|
|
70
99
|
- tech-writerの構造lintを実行する場合はPython 3.9以上
|
|
71
|
-
- 同梱`japanese-prose`の文章lint
|
|
100
|
+
- 同梱`japanese-prose`の文章lint、読解負荷分析、アウトライン抽出、用語検査、編集前後の不変条件検査を実行する場合はPython 3.10以上と`uv`。GiNZA、`ja_ginza`、spaCy、Markdown解析用の依存関係は、各スクリプトの初回実行時に`uv`が解決
|
|
72
101
|
|
|
73
102
|
### npmからインストール
|
|
74
103
|
|
|
75
|
-
パッケージをインストールし、同梱CLI
|
|
104
|
+
パッケージをインストールし、同梱CLIで各スキルを対象のスキルディレクトリへコピーします。
|
|
76
105
|
|
|
77
106
|
```bash
|
|
78
107
|
npm install --save-dev kotonoha
|
|
@@ -81,16 +110,17 @@ npx kotonoha install
|
|
|
81
110
|
|
|
82
111
|
### 同梱スキルをまとめてインストール
|
|
83
112
|
|
|
84
|
-
`kotonoha install`は、まだ存在しない同梱スキルをすべてインストールします。次のコマンドは、`tech-writer`、`japanese-prose`、`presentation-planner`を`.github/skills/`へインストールします。
|
|
113
|
+
`kotonoha install`は、まだ存在しない同梱スキルをすべてインストールします。次のコマンドは、`consulting-analyst`、`tech-writer`、`japanese-prose`、`presentation-planner`を`.github/skills/`へインストールします。
|
|
85
114
|
|
|
86
115
|
```bash
|
|
87
116
|
npm install --save-dev kotonoha
|
|
88
117
|
npx kotonoha install --skill all
|
|
89
118
|
```
|
|
90
119
|
|
|
91
|
-
`--skill all`が既定値であるため、`npx kotonoha install`も同じ動作です。
|
|
120
|
+
`--skill all`が既定値であるため、`npx kotonoha install`も同じ動作です。4つのスキルがインストールされたことを確認します。
|
|
92
121
|
|
|
93
122
|
```bash
|
|
123
|
+
test -f .github/skills/consulting-analyst/SKILL.md
|
|
94
124
|
test -f .github/skills/tech-writer/SKILL.md
|
|
95
125
|
test -f .github/skills/japanese-prose/SKILL.md
|
|
96
126
|
test -f .github/skills/presentation-planner/SKILL.md
|
|
@@ -106,25 +136,53 @@ npx kotonoha install --skill all --force
|
|
|
106
136
|
|
|
107
137
|
kotonohaには独自開発の`japanese-prose`が同梱されるため、文章最適化スキルを別途インストールする必要はありません。`npx kotonoha install`により`tech-writer`と同じスキルルートへ配置され、GiNZAを使った文章lint、読解負荷検査、用語抽出、アウトライン検査、反復的な文章レビューをローカルで実行できます。この実装はkotonoha向けにゼロから開発しており、`natural-japanese`のソースコードを含みません。GiNZAの依存関係とライセンス情報は`skills/japanese-prose/NOTICE.md`に記録しています。
|
|
108
138
|
|
|
109
|
-
|
|
139
|
+
文章lintでは、隣接する助詞・単語の重複、和文括弧の不整合、同一段落内の敬体・常体の混在も確認します。指摘は自動置換の指示ではなく、文脈を確認する対象です。`proofread`モードでは、任意の言い換えを避け、誤字と文法上の誤りだけを最小限に修正します。100点満点のスコアは確認箇所を探す補助であり、訂正精度や品質の保証ではありません。
|
|
140
|
+
|
|
141
|
+
編集前の原文は変更せずに保存します。同梱の`scripts/invariants.py`が、数値、識別子、コード、表、リンク、指定された固有名詞・専門用語などの変更を検査します。編集した文章には、原文と編集後のファイルのハッシュに対応した意味保存レビューが必要です。機械的な一致だけでは、意味が保たれたとは判定しません。レビュー形式と終了コードは、[`review-workflow.md`](skills/japanese-prose/references/review-workflow.md)を参照してください。
|
|
142
|
+
|
|
143
|
+
自然言語で指示するときは、GiNZAを明示する必要はありません。「日本語文書を自然にする」「読みやすくする」「簡潔にする」「AIらしい定型表現を減らす」といった依頼をすると、同梱の文章最適化ワークフローが呼び出されます。
|
|
144
|
+
|
|
145
|
+
```text
|
|
146
|
+
README-ja.mdの日本語を自然で読みやすい表現に修正して
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
```text
|
|
150
|
+
この設計書の不自然な日本語、長すぎる文、AIらしい反復表現を確認し、
|
|
151
|
+
指摘を修正して
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
目的に応じて、次のようにモードを指定できます。
|
|
155
|
+
|
|
156
|
+
- ファイルを修正する: `README-ja.mdの日本語表現を最適化して`
|
|
157
|
+
- 誤りだけを修正する: `README-ja.mdをproofreadモードで校正して。任意の言い換えはせず、誤字と文法上の誤りだけを最小限に修正して`
|
|
158
|
+
- 修正せずにレビューする: `README-ja.mdの日本語をレビューして。ファイルは修正しないで`
|
|
159
|
+
- 採点だけ行う: `README-ja.mdの日本語表現を100点満点で採点して`
|
|
160
|
+
- すべての診断を実行する: `README-ja.mdをfullモードで日本語表現最適化して`
|
|
161
|
+
- GiNZAを明示する: `README-ja.mdをGiNZAで解析し、係り受けや読解負荷を改善して`
|
|
162
|
+
|
|
163
|
+
新しい日本語文書では、`このリポジトリの日本語READMEを作成して`のように依頼すると、`tech-writer`が下書きと構造レビューを行い、rubber-duck reviewの前にGiNZAベースの文章最適化を実行します。文章最適化を確実に指定する場合は、`<ファイル名>を技術文書として作成または修正し、GiNZAによる日本語表現最適化まで実施して`と指示します。
|
|
164
|
+
|
|
165
|
+
既定のインストール先は、現在のプロジェクトの`.github/skills/consulting-analyst`、`.github/skills/tech-writer`、`.github/skills/japanese-prose`、`.github/skills/presentation-planner`です。スキルを1つだけインストールする場合や、対応している別のディレクトリを使用する場合は、次のように指定します。
|
|
110
166
|
|
|
111
167
|
```bash
|
|
168
|
+
npx kotonoha install --skill consulting-analyst
|
|
112
169
|
npx kotonoha install --skill presentation-planner
|
|
113
170
|
npx kotonoha install --target .claude/skills
|
|
114
171
|
npx kotonoha install --target ~/.copilot/skills
|
|
115
172
|
```
|
|
116
173
|
|
|
117
|
-
`--skill <name
|
|
174
|
+
`--skill <name>`を明示したインストールは、既存のスキルディレクトリを上書きしません。すべてのスキルを置き換える場合は、既存のインストールを確認またはバックアップしてから`--force`を指定します。
|
|
118
175
|
|
|
119
176
|
```bash
|
|
120
177
|
npx kotonoha install --force
|
|
121
178
|
```
|
|
122
179
|
|
|
123
|
-
|
|
180
|
+
既定の全スキルインストールでは、既存のスキルディレクトリをスキップし、不足しているスキルだけを追加します。このため、`tech-writer`だけがインストールされた環境にも、ほかの同梱スキルを安全に追加できます。
|
|
124
181
|
|
|
125
182
|
```bash
|
|
126
183
|
npx kotonoha install
|
|
127
184
|
# Skipped tech-writer (...)
|
|
185
|
+
# Installed consulting-analyst (...)
|
|
128
186
|
# Installed japanese-prose (...)
|
|
129
187
|
# Installed presentation-planner (...)
|
|
130
188
|
```
|
|
@@ -139,7 +197,7 @@ npx kotonoha install
|
|
|
139
197
|
npm install --save-dev kotonoha@latest
|
|
140
198
|
```
|
|
141
199
|
|
|
142
|
-
|
|
200
|
+
`next`タグで公開されているプレリリース版を試す場合は、次のようにインストールします。
|
|
143
201
|
|
|
144
202
|
```bash
|
|
145
203
|
npm install --save-dev kotonoha@next
|
|
@@ -154,18 +212,19 @@ npx kotonoha install --force
|
|
|
154
212
|
スキルを1つだけ更新する場合は、次のように実行します。
|
|
155
213
|
|
|
156
214
|
```bash
|
|
215
|
+
npx kotonoha install --skill consulting-analyst --force
|
|
157
216
|
npx kotonoha install --skill tech-writer --force
|
|
158
217
|
npx kotonoha install --skill japanese-prose --force
|
|
159
218
|
npx kotonoha install --skill presentation-planner --force
|
|
160
219
|
```
|
|
161
220
|
|
|
162
|
-
|
|
221
|
+
最初のインストールで別のインストール先を指定した場合は、更新時にも同じディレクトリを指定します。
|
|
163
222
|
|
|
164
223
|
```bash
|
|
165
224
|
npx kotonoha install --target ~/.copilot/skills --force
|
|
166
225
|
```
|
|
167
226
|
|
|
168
|
-
|
|
227
|
+
インストール済みパッケージのバージョンと、置き換えられたファイルの差分をコミット前に確認します。
|
|
169
228
|
|
|
170
229
|
```bash
|
|
171
230
|
npx kotonoha --version
|
|
@@ -178,9 +237,10 @@ git diff -- .github/skills
|
|
|
178
237
|
|
|
179
238
|
このリポジトリでは、スキルが`.github/skills/`配下にリンクされているため、Copilot CLIで使用するための追加設定は不要です。
|
|
180
239
|
|
|
181
|
-
|
|
240
|
+
別のプロジェクトでソースチェックアウトに含まれるスキルを使用する場合は、各スキルのディレクトリを対象リポジトリの`.github/skills/`、`.claude/skills/`、またはグローバルの`~/.copilot/skills/`へコピーします。
|
|
182
241
|
|
|
183
242
|
```bash
|
|
243
|
+
cp -r skills/consulting-analyst /path/to/your-repo/.github/skills/consulting-analyst
|
|
184
244
|
cp -r skills/tech-writer /path/to/your-repo/.github/skills/tech-writer
|
|
185
245
|
cp -r skills/japanese-prose /path/to/your-repo/.github/skills/japanese-prose
|
|
186
246
|
cp -r skills/presentation-planner /path/to/your-repo/.github/skills/presentation-planner
|
|
@@ -209,12 +269,16 @@ python3 skills/tech-writer/scripts/lint.py path/to/document.md
|
|
|
209
269
|
## リポジトリ構成
|
|
210
270
|
|
|
211
271
|
```text
|
|
272
|
+
skills/consulting-analyst/ # 課題構造化と証拠に基づく分析スキル
|
|
273
|
+
SKILL.md # 分析ワークフロー、制約、引き継ぎ
|
|
274
|
+
references/ # フレームワーク選択、証拠規律、引き継ぎ契約
|
|
275
|
+
assets/templates/ # ブリーフ、Issue Tree、証拠、意思決定、統合artifact
|
|
212
276
|
skills/tech-writer/ # tech-writerスキル
|
|
213
277
|
SKILL.md # スキル定義
|
|
214
278
|
references/ # 構成原則、文書種別ごとの規則とチェックリスト
|
|
215
|
-
references/doctypes/ # README、要件、設計、テスト、運用、移行、セキュリティ、API、PR・Issue、リリースノート、提案、RFI・RFP、Qiita・Zenn
|
|
279
|
+
references/doctypes/ # README、要件、設計、テスト、運用、移行、セキュリティ、API、PR・Issue、リリースノート、提案、Blueprint、White Paper、RFI・RFP、Qiita・Zenn
|
|
216
280
|
scripts/lint.py # 構造とMarkdown表示のlintスクリプト
|
|
217
|
-
assets/templates/ #
|
|
281
|
+
assets/templates/ # 要件、設計、テスト、運用、移行、セキュリティ、将来構想、調査・提言、調達などの文書テンプレート
|
|
218
282
|
skills/japanese-prose/ # 独自開発のGiNZAベース文章最適化スキル
|
|
219
283
|
SKILL.md # 執筆、lint、レビュー、収束のワークフロー
|
|
220
284
|
references/ # 執筆規則、レビューワークフロー、採点規則
|
|
@@ -226,12 +290,14 @@ skills/presentation-planner/ # シナリオ、デザイン仕様、PPTX引き継
|
|
|
226
290
|
assets/scenario-templates/ # 経営判断、技術説明、データ報告向けシナリオ
|
|
227
291
|
assets/design-templates/ # 経営提案、技術説明、データ報告向けYAMLデザイン
|
|
228
292
|
.github/skills/tech-writer # Copilot CLIが読み込むskills/tech-writerへのシンボリックリンク
|
|
293
|
+
.github/skills/consulting-analyst
|
|
229
294
|
.github/skills/japanese-prose
|
|
230
295
|
.github/skills/presentation-planner
|
|
231
296
|
```
|
|
232
297
|
|
|
233
298
|
## 既知の制約
|
|
234
299
|
|
|
300
|
+
- `consulting-analyst`は、提供済みまたは検証済みの証拠を構造化します。市場データ、顧客情報、見積もり、引用を捏造しません。
|
|
235
301
|
- `skills/tech-writer/scripts/lint.py`は、見出し、コードブロック、プレースホルダー、リンク、Markdown強調記号などの構造・表示上の問題を検出します。文章の自然さ、語彙、リズム、読解負荷は、別工程として呼び出される同梱`skills/japanese-prose`がGiNZAで検査します。
|
|
236
302
|
- 文書種別は主に日本語の技術文書作成規則を前提としています。コミットメッセージの命令形などを含む多くのガイドは、英語文書にも適用できます。
|
|
237
303
|
- `presentation-planner`だけでは`.pptx`バイナリを生成または検証できません。生成と視覚的な品質確認には専用PPTXスキルが必要です。
|
|
@@ -239,7 +305,7 @@ skills/presentation-planner/ # シナリオ、デザイン仕様、PPTX引き継
|
|
|
239
305
|
|
|
240
306
|
## 謝辞
|
|
241
307
|
|
|
242
|
-
- [GiNZA](https://github.com/megagonlabs/ginza)(MIT License)— kotonoha
|
|
308
|
+
- [GiNZA](https://github.com/megagonlabs/ginza)(MIT License)— kotonoha独自の日本語文章診断に、形態素解析、品詞タグ付け、係り受け解析、原形化、文境界、固有表現抽出を提供します。
|
|
243
309
|
|
|
244
310
|
## ライセンス
|
|
245
311
|
|
package/README.md
CHANGED
|
@@ -1,14 +1,13 @@
|
|
|
1
1
|
# kotonoha
|
|
2
2
|
|
|
3
|
-
kotonoha provides GitHub Copilot CLI skills for
|
|
4
|
-
presentation planning. `
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
material into a reusable presentation scenario, slide outline, design
|
|
3
|
+
kotonoha provides GitHub Copilot CLI skills for consulting analysis, technical
|
|
4
|
+
documents, Japanese prose, and presentation planning. `consulting-analyst`
|
|
5
|
+
structures ambiguous problems into issue trees, hypotheses, evidence, option
|
|
6
|
+
comparisons, and recommendations. `tech-writer` turns that reasoning into
|
|
7
|
+
README, design documents, Blueprints, White Papers, proposals, and other
|
|
8
|
+
technical documents without losing the reader. `japanese-prose` improves
|
|
9
|
+
Japanese wording with GiNZA-based diagnostics. `presentation-planner` turns
|
|
10
|
+
source material into a reusable presentation scenario, slide outline, design
|
|
12
11
|
specification, and handoff for a dedicated PPTX creation skill.
|
|
13
12
|
|
|
14
13
|
[English](./README.md) | [日本語](./README-ja.md)
|
|
@@ -48,11 +47,15 @@ review.
|
|
|
48
47
|
|
|
49
48
|
## What it does
|
|
50
49
|
|
|
50
|
+
- Structure ambiguous business and technical problems with issue trees,
|
|
51
|
+
hypotheses, evidence ledgers, Current–Target–Gap analysis, transparent
|
|
52
|
+
decision matrices, and Pyramid Principle synthesis
|
|
51
53
|
- Create/review README, design docs/ADRs, API reference, PR
|
|
52
54
|
descriptions/commit messages/issue reports, release notes, user manuals,
|
|
53
55
|
code comments, requirements definitions, system designs, test plans,
|
|
54
56
|
operations runbooks, migration plans, security designs, technical proposals,
|
|
55
|
-
RFI/RFP procurement documents, and Qiita/Zenn
|
|
57
|
+
Blueprints, White Papers, RFI/RFP procurement documents, and Qiita/Zenn
|
|
58
|
+
articles
|
|
56
59
|
- Doctype-specific structure and checklists to guide writing
|
|
57
60
|
- Original GiNZA-based `japanese-prose` lint, reading-load review, terminology
|
|
58
61
|
checks, and iterative prose optimization without changing IDs, facts,
|
|
@@ -88,6 +91,8 @@ review.
|
|
|
88
91
|
| User guidance | User manual, how-to guide, tutorial | `user-manual` |
|
|
89
92
|
| Source documentation | Code comments, docstrings | `code-comments` |
|
|
90
93
|
| Internal technical proposal | Architecture, investment, and delivery proposal | `technical-proposal` |
|
|
94
|
+
| Future-state blueprint | Business, operating-model, data, and technology transformation blueprint | `blueprint` |
|
|
95
|
+
| Evidence-led publication | Technical or business White Paper | `white-paper` |
|
|
91
96
|
| Request for information | RFI | `rfi` |
|
|
92
97
|
| Request for proposal | RFP | `rfp` |
|
|
93
98
|
| Technical article | Zenn article | `zenn` |
|
|
@@ -96,10 +101,41 @@ review.
|
|
|
96
101
|
Reusable templates are included for README, design decisions, user manuals,
|
|
97
102
|
PR descriptions, requirements definitions, system designs, test plans,
|
|
98
103
|
operations runbooks, migration plans, security designs, technical proposals,
|
|
99
|
-
RFI, RFP, and Qiita articles. Every supported
|
|
100
|
-
structure guidance and a review checklist under
|
|
104
|
+
Blueprints, White Papers, RFI, RFP, and Qiita articles. Every supported
|
|
105
|
+
doctype includes dedicated structure guidance and a review checklist under
|
|
101
106
|
`skills/tech-writer/references/doctypes/`.
|
|
102
107
|
|
|
108
|
+
## What consulting-analyst does
|
|
109
|
+
|
|
110
|
+
- Defines the decision-maker, decision question, outcome, scope, and evidence
|
|
111
|
+
gaps before a document or presentation is written
|
|
112
|
+
- Selects the smallest useful framework set instead of filling frameworks
|
|
113
|
+
mechanically
|
|
114
|
+
- Builds an issue tree and testable hypothesis/evidence ledger
|
|
115
|
+
- Supports Current–Target–Gap analysis and weighted option comparison with
|
|
116
|
+
scoring anchors and sensitivity analysis
|
|
117
|
+
- Separates facts, estimates, assumptions, interpretations, and
|
|
118
|
+
recommendations
|
|
119
|
+
- Produces a traceable synthesis handoff for `tech-writer` and
|
|
120
|
+
`presentation-planner`
|
|
121
|
+
|
|
122
|
+
Example requests:
|
|
123
|
+
|
|
124
|
+
```text
|
|
125
|
+
Structure this business problem as an issue tree and identify the evidence
|
|
126
|
+
needed to answer each priority issue.
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
```text
|
|
130
|
+
Analyze the current and target states, identify the gaps, and prepare the
|
|
131
|
+
analysis for a Blueprint.
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
```text
|
|
135
|
+
Compare these alternatives using explicit criteria and prepare a White Paper
|
|
136
|
+
handoff without inventing missing evidence.
|
|
137
|
+
```
|
|
138
|
+
|
|
103
139
|
## What presentation-planner does
|
|
104
140
|
|
|
105
141
|
- Defines the audience, decision, call to action, and presentation constraints
|
|
@@ -119,7 +155,8 @@ structure guidance and a review checklist under
|
|
|
119
155
|
|
|
120
156
|
- GitHub Copilot CLI installed
|
|
121
157
|
- Python 3.9+ for tech-writer's structural lint
|
|
122
|
-
- Python 3.10+ and `uv` for the
|
|
158
|
+
- Python 3.10+ and `uv` for the edit-invariant gate and bundled GiNZA
|
|
159
|
+
diagnostics such as prose lint,
|
|
123
160
|
reading-load analysis, outline extraction, and terminology checks; `uv`
|
|
124
161
|
resolves GiNZA, `ja_ginza`, and spaCy on first use
|
|
125
162
|
|
|
@@ -136,8 +173,8 @@ npx kotonoha install
|
|
|
136
173
|
### Install all bundled skills together
|
|
137
174
|
|
|
138
175
|
`kotonoha install` installs every packaged skill that is not already present.
|
|
139
|
-
The following commands install `
|
|
140
|
-
`presentation-planner` into `.github/skills/`:
|
|
176
|
+
The following commands install `consulting-analyst`, `tech-writer`,
|
|
177
|
+
`japanese-prose`, and `presentation-planner` into `.github/skills/`:
|
|
141
178
|
|
|
142
179
|
```bash
|
|
143
180
|
npm install --save-dev kotonoha
|
|
@@ -145,9 +182,10 @@ npx kotonoha install --skill all
|
|
|
145
182
|
```
|
|
146
183
|
|
|
147
184
|
`--skill all` is the default, so `npx kotonoha install` has the same behavior.
|
|
148
|
-
Confirm that all
|
|
185
|
+
Confirm that all four skills were installed:
|
|
149
186
|
|
|
150
187
|
```bash
|
|
188
|
+
test -f .github/skills/consulting-analyst/SKILL.md
|
|
151
189
|
test -f .github/skills/tech-writer/SKILL.md
|
|
152
190
|
test -f .github/skills/japanese-prose/SKILL.md
|
|
153
191
|
test -f .github/skills/presentation-planner/SKILL.md
|
|
@@ -172,12 +210,55 @@ scratch for kotonoha and does not include `natural-japanese` source code.
|
|
|
172
210
|
GiNZA dependency and license information is recorded in
|
|
173
211
|
`skills/japanese-prose/NOTICE.md`.
|
|
174
212
|
|
|
175
|
-
The
|
|
176
|
-
|
|
213
|
+
The lint also flags adjacent duplicate particles/words, Japanese bracket
|
|
214
|
+
mismatches, and polite/plain style mixing within a paragraph. Findings are
|
|
215
|
+
review targets, not automatic replacements. Use `proofread` mode for minimal
|
|
216
|
+
typo/grammar corrections without optional stylistic rewriting. The 0–100
|
|
217
|
+
score is a triage aid, not correction accuracy or a quality certificate.
|
|
218
|
+
|
|
219
|
+
Before editing, the workflow saves an immutable original. The bundled
|
|
220
|
+
`scripts/invariants.py` checks protected content and requires a hash-bound
|
|
221
|
+
semantic review of changed prose. Numbers, identifiers, code, tables, links,
|
|
222
|
+
and caller-supplied proper names/domain terms cannot be silently changed.
|
|
223
|
+
Mechanical equality alone does not establish preserved meaning. See
|
|
224
|
+
[`review-workflow.md`](skills/japanese-prose/references/review-workflow.md)
|
|
225
|
+
for the review format and gate exit codes.
|
|
226
|
+
|
|
227
|
+
You do not need to name GiNZA explicitly in a natural-language request.
|
|
228
|
+
Requests to make a Japanese document more natural, readable, concise, or less
|
|
229
|
+
formulaic invoke the bundled prose-optimization workflow. For example:
|
|
230
|
+
|
|
231
|
+
```text
|
|
232
|
+
Rewrite README-ja.md in natural, readable Japanese.
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
```text
|
|
236
|
+
Review this design document for unnatural Japanese, overly long sentences,
|
|
237
|
+
and repetitive AI-like phrasing, then fix the findings.
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
You can specify the intended mode more precisely:
|
|
241
|
+
|
|
242
|
+
- Edit the file: `Optimize the Japanese prose in README-ja.md.`
|
|
243
|
+
- Correct errors only: `Proofread README-ja.md; make minimal typo/grammar corrections without stylistic rewrites.`
|
|
244
|
+
- Review without editing: `Review the Japanese in README-ja.md, but do not modify the file.`
|
|
245
|
+
- Score only: `Score the Japanese prose in README-ja.md out of 100.`
|
|
246
|
+
- Run every diagnostic: `Run the full Japanese prose optimization workflow on README-ja.md.`
|
|
247
|
+
- Request GiNZA explicitly: `Analyze README-ja.md with GiNZA and improve dependency depth and reading load.`
|
|
248
|
+
|
|
249
|
+
When creating a new Japanese document, asking `Create a Japanese README for
|
|
250
|
+
this repository` lets `tech-writer` create and structurally review the draft,
|
|
251
|
+
then run the GiNZA-based prose pass before rubber-duck review. To require the
|
|
252
|
+
pass unambiguously, ask: `Create or revise <file> as a technical document and
|
|
253
|
+
run GiNZA-based Japanese prose optimization.`
|
|
254
|
+
|
|
255
|
+
The default destinations are `.github/skills/consulting-analyst`,
|
|
256
|
+
`.github/skills/tech-writer`, `.github/skills/japanese-prose`, and
|
|
177
257
|
`.github/skills/presentation-planner` in the current project. To install only
|
|
178
258
|
one skill, or use another supported skill directory:
|
|
179
259
|
|
|
180
260
|
```bash
|
|
261
|
+
npx kotonoha install --skill consulting-analyst
|
|
181
262
|
npx kotonoha install --skill presentation-planner
|
|
182
263
|
npx kotonoha install --target .claude/skills
|
|
183
264
|
npx kotonoha install --target ~/.copilot/skills
|
|
@@ -198,6 +279,7 @@ installation safe:
|
|
|
198
279
|
```bash
|
|
199
280
|
npx kotonoha install
|
|
200
281
|
# Skipped tech-writer (...)
|
|
282
|
+
# Installed consulting-analyst (...)
|
|
201
283
|
# Installed japanese-prose (...)
|
|
202
284
|
# Installed presentation-planner (...)
|
|
203
285
|
```
|
|
@@ -230,6 +312,7 @@ npx kotonoha install --force
|
|
|
230
312
|
To update only one skill:
|
|
231
313
|
|
|
232
314
|
```bash
|
|
315
|
+
npx kotonoha install --skill consulting-analyst --force
|
|
233
316
|
npx kotonoha install --skill tech-writer --force
|
|
234
317
|
npx kotonoha install --skill japanese-prose --force
|
|
235
318
|
npx kotonoha install --skill presentation-planner --force
|
|
@@ -263,6 +346,7 @@ into that repository's `.github/skills/`, `.claude/skills/`, or your global
|
|
|
263
346
|
`~/.copilot/skills/`.
|
|
264
347
|
|
|
265
348
|
```bash
|
|
349
|
+
cp -r skills/consulting-analyst /path/to/your-repo/.github/skills/consulting-analyst
|
|
266
350
|
cp -r skills/tech-writer /path/to/your-repo/.github/skills/tech-writer
|
|
267
351
|
cp -r skills/japanese-prose /path/to/your-repo/.github/skills/japanese-prose
|
|
268
352
|
cp -r skills/presentation-planner /path/to/your-repo/.github/skills/presentation-planner
|
|
@@ -292,12 +376,16 @@ works too (standard library only).
|
|
|
292
376
|
## Repository layout
|
|
293
377
|
|
|
294
378
|
```text
|
|
379
|
+
skills/consulting-analyst/ # problem structuring and evidence-led analysis skill
|
|
380
|
+
SKILL.md # analysis workflow, safeguards, and handoff
|
|
381
|
+
references/ # framework selection, evidence discipline, handoff contract
|
|
382
|
+
assets/templates/ # brief, issue tree, evidence, decision, and synthesis artifacts
|
|
295
383
|
skills/tech-writer/ # the skill itself
|
|
296
384
|
SKILL.md # skill definition
|
|
297
385
|
references/ # structure constitution + doctype rules/checklists
|
|
298
|
-
references/doctypes/ # README, requirements/design/test/operations/migration/security, API docs, PR/issue, release notes, proposals, RFI/RFP, Qiita/Zenn
|
|
386
|
+
references/doctypes/ # README, requirements/design/test/operations/migration/security, API docs, PR/issue, release notes, proposals, Blueprints, White Papers, RFI/RFP, Qiita/Zenn
|
|
299
387
|
scripts/lint.py # structural lint script
|
|
300
|
-
assets/templates/ # doctype skeletons including requirements, design, test, operations, migration, security, and procurement
|
|
388
|
+
assets/templates/ # doctype skeletons including requirements, design, test, operations, migration, security, strategy, evidence-led publications, and procurement
|
|
301
389
|
skills/japanese-prose/ # original GiNZA-based prose optimization skill
|
|
302
390
|
SKILL.md # writing, lint, review, and convergence workflow
|
|
303
391
|
references/ # writing guidelines, review workflow, and scoring
|
|
@@ -309,12 +397,15 @@ skills/presentation-planner/ # storyline, design-spec, and PPTX handoff skill
|
|
|
309
397
|
assets/scenario-templates/ # executive, technical, and data-report narrative scenarios
|
|
310
398
|
assets/design-templates/ # executive, technical, and data-report YAML designs
|
|
311
399
|
.github/skills/tech-writer # symlink to skills/tech-writer (where Copilot CLI reads it)
|
|
400
|
+
.github/skills/consulting-analyst
|
|
312
401
|
.github/skills/japanese-prose
|
|
313
402
|
.github/skills/presentation-planner
|
|
314
403
|
```
|
|
315
404
|
|
|
316
405
|
## Known limitations
|
|
317
406
|
|
|
407
|
+
- `consulting-analyst` structures supplied or verified evidence but does not
|
|
408
|
+
manufacture market data, customer facts, estimates, or citations.
|
|
318
409
|
- `skills/tech-writer/scripts/lint.py` detects structural and Markdown
|
|
319
410
|
rendering issues. Prose naturalness, vocabulary, rhythm, and reading load
|
|
320
411
|
are handled by the separately invoked but bundled
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "kotonoha",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "GitHub Copilot CLI skills for technical writing and PPTX
|
|
3
|
+
"version": "0.4.0",
|
|
4
|
+
"description": "GitHub Copilot CLI skills for consulting analysis, technical writing, Japanese prose, and PPTX planning.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "nahisaho",
|
|
7
7
|
"repository": {
|
|
@@ -27,6 +27,9 @@
|
|
|
27
27
|
"github-copilot",
|
|
28
28
|
"skill",
|
|
29
29
|
"technical-writing",
|
|
30
|
+
"consulting",
|
|
31
|
+
"analysis",
|
|
32
|
+
"strategy",
|
|
30
33
|
"documentation",
|
|
31
34
|
"markdown",
|
|
32
35
|
"presentation",
|