asciidoc-pubkit 0.8.2 → 0.8.3
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +9 -0
- data/README.md +19 -7
- data/data/review-rules.ja.yml +25 -1
- data/data/writing/ja/criteria.md +53 -2
- data/lib/asciidoc_pubkit.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1302c0c833ffbfdb14eff663bc8a30c80449ddf6ab065fc440c85e103189a87d
|
|
4
|
+
data.tar.gz: 47c5bc1c86b79a3130406f562cd099cd4b76cf4e7a6aa95c17122c14835fcee1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: bd1665669a9d3de5c4b27218c3886e6c0de4c03410f533de318278644c26a8ac467665af74f9026cc39b3243c05afba6fb98ede1bf9c7e4fa922ca6db0fb941e
|
|
7
|
+
data.tar.gz: a5090e7e0efbcb464e694f413312e942c6e88bf4d84749763d0e40971ee3b0f4cffe564f174d8c8c5368f81ffd7fa353cbccebf0d84117e81d051c5ff1e44f45
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.8.3 — 2026-10-02
|
|
4
|
+
|
|
5
|
+
- Refine shared Japanese writing and review criteria for established technical
|
|
6
|
+
terminology, precise operations, direct predicates, and evidence-based tone.
|
|
7
|
+
Preserve distinctions between assumptions, requirements, and capabilities.
|
|
8
|
+
- Add scoped review candidates for unusual translations, everyday operation
|
|
9
|
+
wording, indirect predicates, and author-centered emphasis; reuse existing
|
|
10
|
+
noun, verb, and qualification rules instead of fixed automatic replacements.
|
|
11
|
+
|
|
3
12
|
## 0.8.2 — 2026-10-02
|
|
4
13
|
|
|
5
14
|
- Report replacement rule errors with the original YAML filename and one-based
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
|
|
8
8
|
A toolkit for authoring and reviewing AsciiDoc books.
|
|
9
9
|
|
|
10
|
-
Version 0.8.
|
|
10
|
+
Version 0.8.3 provides shared Japanese technical writing criteria, an authoring
|
|
11
11
|
prompt, separate prose and heading review prompts, manuscript scoring, and
|
|
12
12
|
baseline verification for edited manuscripts, plus explicit prose-only mechanical
|
|
13
13
|
replacements using a limited prh-format rule set.
|
|
@@ -16,7 +16,7 @@ Japanese text is retained in manuscript excerpts, rule dictionaries, and fixture
|
|
|
16
16
|
|
|
17
17
|
## Available features
|
|
18
18
|
|
|
19
|
-
The following commands are available in version 0.8.
|
|
19
|
+
The following commands are available in version 0.8.3.
|
|
20
20
|
|
|
21
21
|
| Feature | Commands | Behavior |
|
|
22
22
|
| --- | --- | --- |
|
|
@@ -107,7 +107,7 @@ Add the gem to your project's `Gemfile` to manage its version with Bundler:
|
|
|
107
107
|
|
|
108
108
|
```ruby
|
|
109
109
|
source 'https://rubygems.org'
|
|
110
|
-
gem 'asciidoc-pubkit', '~> 0.8.
|
|
110
|
+
gem 'asciidoc-pubkit', '~> 0.8.3'
|
|
111
111
|
```
|
|
112
112
|
|
|
113
113
|
Then install dependencies and run the CLI through Bundler:
|
|
@@ -129,7 +129,7 @@ git clone https://github.com/cybergarage/asciidoc-pubkit.git
|
|
|
129
129
|
cd asciidoc-pubkit
|
|
130
130
|
bundle install
|
|
131
131
|
gem build asciidoc-pubkit.gemspec
|
|
132
|
-
gem install ./asciidoc-pubkit-0.8.
|
|
132
|
+
gem install ./asciidoc-pubkit-0.8.3.gem
|
|
133
133
|
asciidoc-pubkit --version
|
|
134
134
|
```
|
|
135
135
|
|
|
@@ -153,7 +153,7 @@ asciidoc-pubkit writing prompt --lang ja --output writing-prompt.md
|
|
|
153
153
|
```
|
|
154
154
|
|
|
155
155
|
For example, `--lang en` exits with an unsupported-language error. No English
|
|
156
|
-
review or writing criteria are shipped in 0.8.
|
|
156
|
+
review or writing criteria are shipped in 0.8.3.
|
|
157
157
|
|
|
158
158
|
For a small trial, use `examples/book.adoc` as the scan input. Its Japanese
|
|
159
159
|
paragraphs deliberately contain review candidates; its code block must remain
|
|
@@ -1005,6 +1005,18 @@ These are candidates for contextual review, not banned expressions. A necessary
|
|
|
1005
1005
|
condition, uncertainty, or distinction must survive a revision; a redundant
|
|
1006
1006
|
disclaimer can instead be removed or folded into a more precise main claim.
|
|
1007
1007
|
|
|
1008
|
+
Version 0.8.3 also includes scoped candidates such as `構築入口`,
|
|
1009
|
+
`エラーを回収する`, `ツールを呼ぶ`, `したりできます`, and `設計の肝`.
|
|
1010
|
+
These additions use the exact surfaces listed in the YAML in both modes;
|
|
1011
|
+
they do not add general inflection coverage or ban everyday verbs. Existing
|
|
1012
|
+
`木`, `持つ`, `書く`, `別です`, and `ではありません` rules cover related examples.
|
|
1013
|
+
The shared criteria explain context-dependent terminology, precise operations,
|
|
1014
|
+
direct predicates, and objective tone. They distinguish invocation from
|
|
1015
|
+
execution, configuration text from configuration changes, assumptions from
|
|
1016
|
+
requirements, and collecting errors from catching them. Suggested alternatives
|
|
1017
|
+
are not automatic replacement rules. Start a new review session to include
|
|
1018
|
+
updated rules and criteria; existing sessions retain their saved versions.
|
|
1019
|
+
|
|
1008
1020
|
Metaphorical-operation candidates include limited exact surfaces of
|
|
1009
1021
|
`地味に効く`, `静かに壊れる`, `時間を溶かす`, and `側に倒す`, including selected polite,
|
|
1010
1022
|
past, and connective forms listed in the packaged YAML. They use contextual
|
|
@@ -1057,12 +1069,12 @@ reports analyzer changes instead of treating results from different dictionaries
|
|
|
1057
1069
|
as directly comparable. Prompt generation uses saved evidence and does not need
|
|
1058
1070
|
MeCab. Changed rules or dictionary settings require a new scan.
|
|
1059
1071
|
|
|
1060
|
-
Sessions from earlier tool versions are not compatible with 0.8.
|
|
1072
|
+
Sessions from earlier tool versions are not compatible with 0.8.3 (session schema 2). Keep the original baseline for
|
|
1061
1073
|
an ongoing review and finish it with the original version, or start a new review
|
|
1062
1074
|
pass in a different directory:
|
|
1063
1075
|
|
|
1064
1076
|
```sh
|
|
1065
|
-
asciidoc-pubkit review scan book.adoc --output .pubkit/review-0.8.
|
|
1077
|
+
asciidoc-pubkit review scan book.adoc --output .pubkit/review-0.8.3
|
|
1066
1078
|
```
|
|
1067
1079
|
|
|
1068
1080
|
Severity describes review priority, not proof of an error. There is no AI-authorship
|
data/data/review-rules.ja.yml
CHANGED
|
@@ -135,6 +135,25 @@ terms:
|
|
|
135
135
|
# Retain this specific phrase for existing allow lists and fuller evidence.
|
|
136
136
|
- わけではありません
|
|
137
137
|
- 別です
|
|
138
|
+
# Unusual technical translations; shared criteria own the alternatives.
|
|
139
|
+
- 構築入口
|
|
140
|
+
- 実装の読解
|
|
141
|
+
- エラーを回収する
|
|
142
|
+
- エラーを回収します
|
|
143
|
+
- 介入パターン
|
|
144
|
+
# Object-specific everyday verbs, not general bans on these verbs.
|
|
145
|
+
- ツールを呼ぶ
|
|
146
|
+
- ツールを呼びます
|
|
147
|
+
- 責務を持つ
|
|
148
|
+
- 指示を読み取る
|
|
149
|
+
- 指示を読み取ります
|
|
150
|
+
- 設定を書く
|
|
151
|
+
- 値を拾う
|
|
152
|
+
- 値を拾います
|
|
153
|
+
- 切り出す合図です
|
|
154
|
+
# Indirect capabilities and prerequisites; preserve their modality.
|
|
155
|
+
- したりできます
|
|
156
|
+
- することが前提です
|
|
138
157
|
# Compressed noun relationships; suggestions are not automatic replacements.
|
|
139
158
|
- 明示選択
|
|
140
159
|
- 欠落理由
|
|
@@ -158,7 +177,8 @@ terms:
|
|
|
158
177
|
- でもありません
|
|
159
178
|
- してはいけません
|
|
160
179
|
- 表してはいません
|
|
161
|
-
question:
|
|
180
|
+
question: Apply the shared prose criteria to terminology, operation wording,
|
|
181
|
+
indirect predicates, and qualifications. Check whether the phrase adds a condition that changes the reader's
|
|
162
182
|
interpretation or action. If it only denies an overbroad reading already
|
|
163
183
|
excluded by the main claim, revise that claim or remove the qualification.
|
|
164
184
|
Preserve necessary negation, uncertainty, and technical boundaries. For
|
|
@@ -176,6 +196,10 @@ terms:
|
|
|
176
196
|
- まとめると
|
|
177
197
|
- このように
|
|
178
198
|
- 要するに
|
|
199
|
+
# Author-centered discovery, indirect explanation, and unsupported emphasis.
|
|
200
|
+
- 見えてきます
|
|
201
|
+
- 理由がここにあります
|
|
202
|
+
- 設計の肝
|
|
179
203
|
question: Check whether this opening or recap adds a claim, scope, or consequence
|
|
180
204
|
beyond the surrounding prose. Keep useful framing; otherwise state the
|
|
181
205
|
substantive claim directly. Do not force a uniform sentence pattern.
|
data/data/writing/ja/criteria.md
CHANGED
|
@@ -66,6 +66,21 @@ Prefer a precise action or consequence:
|
|
|
66
66
|
- `結果を残します` becomes `実行したコマンドと結果をプルリクエストへ記録します`
|
|
67
67
|
when that is the storage location.
|
|
68
68
|
|
|
69
|
+
For everyday verbs, identify the operation before choosing terminology:
|
|
70
|
+
|
|
71
|
+
| Wording to inspect | Revision when supported by context |
|
|
72
|
+
| --- | --- |
|
|
73
|
+
| ツールを呼ぶ | 呼び出す for invocation; 実行する only for execution |
|
|
74
|
+
| 責務を持つ | 責務を担う when describing responsibility, not stored state or ownership |
|
|
75
|
+
| 指示を読み取る | 解析する for parsing or analysis; 抽出する for selecting information |
|
|
76
|
+
| 設定を書く・設定を書きます | 設定を記述する・定義する for authoring a definition; 設定する for actually configuring something |
|
|
77
|
+
| 値を拾う | 取得する for retrieval; 抽出する for selection from existing data |
|
|
78
|
+
| 切り出す合図です | 切り出す目安です for a judgment criterion; シグナルです only for an actual signal |
|
|
79
|
+
|
|
80
|
+
A familiar verb is not wrong merely because it is simple. Prefer the most direct
|
|
81
|
+
accurate verb; do not introduce jargon or claim parsing, execution, or a state
|
|
82
|
+
change that the evidence does not establish.
|
|
83
|
+
|
|
69
84
|
Do not choose a more impressive synonym merely to vary sentence endings. Keep
|
|
70
85
|
the technically correct verb when it names the real operation.
|
|
71
86
|
|
|
@@ -156,6 +171,27 @@ Common patterns that merit paragraph-level review include:
|
|
|
156
171
|
Keep a contrast when the two alternatives and the difference that affects the
|
|
157
172
|
decision are explicit. Keep necessary repetition when it improves technical
|
|
158
173
|
accuracy.
|
|
174
|
+
Inspect indirect predicates and author-centered emphasis as well:
|
|
175
|
+
|
|
176
|
+
- Simplify `無効化したりできます` to `無効化できます` when it describes a single
|
|
177
|
+
capability. Preserve `たり` when it marks a meaningful non-exhaustive list.
|
|
178
|
+
- For `提供することが前提です`, identify whose prerequisite or assumption is
|
|
179
|
+
stated. Use `提供する必要があります` only when the source establishes an actual
|
|
180
|
+
requirement; do not turn an assumption into an obligation.
|
|
181
|
+
- For `宣言することは別です`, name what is compared and how it differs. A form such
|
|
182
|
+
as `宣言することとは異なります` needs an explicit, correctly oriented comparison.
|
|
183
|
+
- For `そうではありません`, state the specific fact or negate the specific claim.
|
|
184
|
+
`実際には異なります` alone can retain the same missing referent. Preserve negation.
|
|
185
|
+
- For `〜が見えてきます`, state the property the explanation makes identifiable.
|
|
186
|
+
`理解しやすくなります` is still a reader-effect claim that needs support; retain
|
|
187
|
+
literal visibility when discussing a display or visualization.
|
|
188
|
+
- For `理由がここにあります`, connect the cause and result directly, for example
|
|
189
|
+
`これが〜の理由です` when `これ` has a clear referent.
|
|
190
|
+
- For `設計の肝です`, identify the central responsibility or design decision.
|
|
191
|
+
`重要なポイントです` is not sufficient when it merely replaces one emphasis
|
|
192
|
+
phrase with another. Remove emotional, essay-like, or promotional emphasis
|
|
193
|
+
that supplies no technical fact; retain supported judgments and their basis.
|
|
194
|
+
|
|
159
195
|
Do not shorten sentences or vary endings mechanically. Read the sequence aloud
|
|
160
196
|
and repair the missing relationship rather than replacing one stock pattern
|
|
161
197
|
with another.
|
|
@@ -170,12 +206,27 @@ glossary, and primary documentation before changing it.
|
|
|
170
206
|
- Distinguish resource ownership from the responsibility to close or stop it.
|
|
171
207
|
- Use the project's chosen forms consistently, such as `goroutine` versus
|
|
172
208
|
`ゴルーチン`, or `reflection` versus `リフレクション`.
|
|
173
|
-
-
|
|
174
|
-
|
|
209
|
+
- Prefer established terminology in the technical domain, whether Japanese or
|
|
210
|
+
katakana. Avoid forced literal translations and unnecessary English; retain
|
|
211
|
+
identifiers, official names, and the project's chosen terminology.
|
|
175
212
|
- Do not describe a language operation with a loose everyday verb when the
|
|
176
213
|
domain has a precise term, such as name shadowing, method promotion, parsing,
|
|
177
214
|
serialization, cancellation, or resource release.
|
|
178
215
|
|
|
216
|
+
Review unusual translations against the actual concept:
|
|
217
|
+
|
|
218
|
+
| Wording to inspect | Context-dependent terminology |
|
|
219
|
+
| --- | --- |
|
|
220
|
+
| 木 | ツリー when referring to the data structure; keep literal trees and established mathematical usage |
|
|
221
|
+
| 構築入口 | ビルドのエントリポイント only when the entry point starts a build, not object construction or initialization |
|
|
222
|
+
| 実装の読解 | コードリーディング for reading code; 実装の解析 when analysis is the actual task |
|
|
223
|
+
| エラーを回収する | エラーを捕捉する for catching; ハンドリングする for handling; preserve aggregation or collection when that is the behavior |
|
|
224
|
+
| 介入パターン | フックパターン only when a hook mechanism is established, not arbitrary human intervention |
|
|
225
|
+
|
|
226
|
+
These alternatives are not interchangeable replacements. Confirm the operation
|
|
227
|
+
and the domain's established usage from code, the glossary, or primary
|
|
228
|
+
documentation; record uncertainty rather than inventing a mechanism.
|
|
229
|
+
|
|
179
230
|
Natural Japanese must not erase a technical distinction. If the original claim
|
|
180
231
|
is ambiguous, inspect the code or authoritative documentation before editing.
|
|
181
232
|
Preserve numerical values, versions, settings, responsibility, causal claims,
|
data/lib/asciidoc_pubkit.rb
CHANGED