asciidoc-pubkit 1.0.2 → 1.0.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 905d849fe8f73050f29a9a30178a97487220b732b9d4b512e239708cd4141183
4
- data.tar.gz: 49fda58238752aa5428f5ae01dcecd2ee064647686f42e98daf36cf47114d67b
3
+ metadata.gz: 1ca3e56810daf83687c0758172892f89e2acba8bc0d16c909fa0da8183617179
4
+ data.tar.gz: 69ba46436e3316058ff76f916325db0d3c6e94ce8a2700915cdd25c20d53e99a
5
5
  SHA512:
6
- metadata.gz: 1f4faad90e82bbfcdff69672807169610db35c9eb36d0863f32e5a3d44af97e2d67ebdcdea6505197a3163cc65c3eed2232dc236f2078415776acfe60358bfcf
7
- data.tar.gz: 99c3dc7d0c57ac49d05340e29e4a224eb2676a3a26ba52c6ad2f44691dfa7e8cf3b74b82992bffa7eaa3e714098caf236cf21e7b4f6eab4bd2d56dd369e07330
6
+ metadata.gz: f2d203eec585c19961aab955cf1d3ddd98712569c14e9d85898f810750d24a5f8a3e8db2752503ec74094e58ffcb4ed6a9eb6932e23512dc5a3d688350a95021
7
+ data.tar.gz: 301e914f2bc66bdfbc2342c7beacda5d8b47ac6a30c50c51afdf3b1695212d45bc948ae73fdf20ea505431f0664e4ebc42c3511f668f54eb98a7f105a1007aad
data/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.0.3 — 2026-10-07
4
+
5
+ - Adapt yomiyasu v1.0.8 guidance to preserve comparison axes, completed/current/
6
+ planned status, event and observation dates, attribution, and known operations
7
+ despite unclear state descriptions. Keep actual source uncertainty in the
8
+ manuscript and reviewer questions in the separate report.
9
+ - Expand the original evaluation corpus from 21 to 26 paragraphs as
10
+ `technical-prose-v3`, and revision calibration from 31 to 43 pairs. Extend the
11
+ judge rubric for these distinctions; require fresh AI baselines for the changed
12
+ corpus, calibration, and rubric. Add paragraph-boundary and soft-line-break
13
+ repetition regressions without changing detector rules or verification semantics.
14
+
3
15
  ## 1.0.2 — 2026-10-05
4
16
 
5
17
  - Add contextual prose candidates for 分かる, 置く, 変える, 発火, 短い, and 長い,
data/README.md CHANGED
@@ -16,7 +16,7 @@ and books on health, exercise, and sports science published under
16
16
  The experience informs the toolkit's writing criteria, contextual review prompts,
17
17
  and checks for preserving manuscript content during revision.
18
18
 
19
- Version 1.0.2 provides document inspection, explicit prose-only mechanical
19
+ Version 1.0.3 provides document inspection, explicit prose-only mechanical
20
20
  replacements, and Japanese manuscript review. Inspect a book's outline,
21
21
  metadata, and local cross-references; preview and apply your replacement rules;
22
22
  then review and verify edits against a saved baseline.
@@ -26,7 +26,7 @@ Japanese manuscript excerpts and rule terms retain their original text.
26
26
 
27
27
  ## Available features
28
28
 
29
- The following commands are available in version 1.0.2.
29
+ The following commands are available in version 1.0.3.
30
30
 
31
31
  | Feature | Commands | Behavior |
32
32
  | --- | --- | --- |
@@ -49,6 +49,10 @@ with structural comparison before and after revision and preservation of sentenc
49
49
  functions and plain or polite style. The [development evaluation](docs/prose-evaluation.md)
50
50
  includes new cases for these checks.
51
51
 
52
+ Version 1.0.3 additionally preserves comparison axes, temporal roles,
53
+ and known actions in unclear passages, separating source uncertainty from editorial
54
+ questions. The evaluation guide describes the expanded corpus and calibration.
55
+
52
56
  ## Requirements and scope
53
57
 
54
58
  Ruby 3.2 or later is required; RubyGems installs Asciidoctor and the other Ruby
@@ -81,7 +85,7 @@ asciidoc-pubkit --help
81
85
  ```
82
86
 
83
87
  To update, run `gem update asciidoc-pubkit`. For Bundler, add
84
- `gem 'asciidoc-pubkit', '~> 1.0.2'` to your project's `Gemfile` and run commands
88
+ `gem 'asciidoc-pubkit', '~> 1.0.3'` to your project's `Gemfile` and run commands
85
89
  through `bundle exec`. See [source installation and local checkout usage](docs/installation.md).
86
90
 
87
91
  ## Quick start
@@ -121,7 +125,7 @@ asciidoc-pubkit writing prompt --lang ja --output writing-prompt.md
121
125
 
122
126
  Existing review sessions require the exact tool version that created them.
123
127
  Before upgrading, finish ongoing reviews with that version or preserve their
124
- baselines and start a new review in a separate directory with v1.0.2. A new
128
+ baselines and start a new review in a separate directory with v1.0.3. A new
125
129
  scan cannot verify preservation relative to an earlier baseline.
126
130
 
127
131
  ## Documentation
@@ -10,6 +10,7 @@
10
10
  - Make relationships explicit
11
11
  - Compare structure before and after revision
12
12
  - Keep claims within their evidence and purpose
13
+ - Keep source uncertainty separate from editorial questions
13
14
  - Remove generated-prose patterns without flattening the meaning
14
15
  - Preserve exact technical terminology
15
16
  - Revise the complete paragraph
@@ -165,6 +166,13 @@ action, or an evaluation into an implementation goal. Sequence words such as
165
166
  behavior. When the function or actor is unresolved, retain the uncertainty and
166
167
  record what needs confirmation.
167
168
 
169
+ Keep completed changes, current behavior or policy, and future plans distinct.
170
+ `上限を3回へ変更しました` reports a completed change; `最大3回再送します`
171
+ can describe current behavior; `変更する予定です` describes a plan. Do not
172
+ change tense merely to vary endings. Current behavior alone does not establish
173
+ that it was introduced or changed in this revision. Report a change only when
174
+ the source establishes it; do not invent an earlier state or improvement.
175
+
168
176
  Preserve plain or polite style unless the author requests a change or the book's
169
177
  explicit style requirements call for one. A technical topic alone does not
170
178
  require polite style. Resolve unintended style mixing separately from each
@@ -221,6 +229,13 @@ Use these checks when splitting, joining, or rearranging sentences:
221
229
  - Preserve the scope and direction of purpose, reason, contrast, and emphasis.
222
230
  A purpose applying to two operations must still apply to both after splitting;
223
231
  necessary contrast or priority must not become simple addition or equality.
232
+ - Preserve the comparison axis as well as the alternatives and rank. Calling
233
+ a problem the most important does not establish that it is the most frequent
234
+ or easiest to overlook. Keep an unresolved comparison unresolved.
235
+ - Distinguish the time an event occurred from when someone observed, learned,
236
+ or reported it. `9月2日に、9月1日に障害が発生したと聞きました` must not
237
+ become `9月2日に障害が発生しました`. Preserve attribution and distinguish
238
+ reported evidence from direct observation.
224
239
 
225
240
  Adjust punctuation when it obscures these relationships, not merely to reduce
226
241
  comma counts. Keep a colon that maps a label to a value, such as `状態: 正常`,
@@ -242,6 +257,27 @@ affects use, implementation, or verification, state the concrete condition and
242
257
  connect it to the relevant action or check. Do not delete a technical boundary
243
258
  merely because it uses negative wording.
244
259
 
260
+ ## Keep source uncertainty separate from editorial questions
261
+
262
+ Retain an actual undecided or under-investigation state in the reader-facing
263
+ body, including its time and scope. A reviewer not understanding a phrase does
264
+ not establish that the author or implementation is uncertain. Do not add
265
+ `要確認`, questions, or editorial explanations to the manuscript; put reviewer
266
+ questions and proposed alternatives in the separate review report. Report missing
267
+ evidence without weakening an established operation or inventing a new actor.
268
+
269
+ When a state description is unclear but its associated action is known, preserve
270
+ both the source wording's scope and the known action in the body. For example,
271
+ `破綻したメッセージは隔離します` does not establish a signature failure, nor
272
+ does uncertainty about `破綻` authorize deleting the isolation operation. Retain
273
+ the term when a faithful alternative cannot be established and record the exact
274
+ question separately. Quoting the operation only in a confirmation item does not
275
+ preserve it in the manuscript. Keep source-provided `未定` or `調査中` statements;
276
+ do not turn them into reviewer notes or omit them as editing clutter.
277
+
278
+ These instructions do not authorize edits to protected content or new manuscript
279
+ annotations. Preserve the selected review scope and keep unreviewed items pending.
280
+
245
281
  ## Remove generated-prose patterns without flattening the meaning
246
282
 
247
283
  Common patterns that merit paragraph-level review include:
@@ -1,6 +1,6 @@
1
1
  # Document commands
2
2
 
3
- Version 1.0.2 provides four read-only document commands. They require neither
3
+ Version 1.0.3 provides four read-only document commands. They require neither
4
4
  MeCab nor an AI CLI, accept documents in any language, and do not create review
5
5
  sessions or change manuscripts.
6
6
 
data/docs/installation.md CHANGED
@@ -41,7 +41,7 @@ Add the gem to your project's `Gemfile` to manage its version with Bundler:
41
41
 
42
42
  ```ruby
43
43
  source 'https://rubygems.org'
44
- gem 'asciidoc-pubkit', '~> 1.0.2'
44
+ gem 'asciidoc-pubkit', '~> 1.0.3'
45
45
  ```
46
46
 
47
47
  Then install dependencies and run the CLI through Bundler:
@@ -66,7 +66,7 @@ git clone https://github.com/cybergarage/asciidoc-pubkit.git
66
66
  cd asciidoc-pubkit
67
67
  bundle install
68
68
  gem build asciidoc-pubkit.gemspec
69
- gem install ./asciidoc-pubkit-1.0.2.gem
69
+ gem install ./asciidoc-pubkit-1.0.3.gem
70
70
  asciidoc-pubkit --version
71
71
  ```
72
72
 
@@ -5,8 +5,9 @@ criteria changes against a project-defined baseline. Keep detection performance,
5
5
  readability, and meaning preservation separate so that a clearer rewrite cannot
6
6
  hide a lost condition or invented fact.
7
7
 
8
- This guide describes version 1.0.2, including the
9
- `technical-prose-v2` corpus and expanded revision calibration. The evaluation runner is not an
8
+ This guide describes the version 1.0.3 development checkout, including the
9
+ `technical-prose-v3` corpus and expanded revision calibration.
10
+ The evaluation runner is not an
10
11
  installed gem command. It does not measure Japanese naturalness or AI authorship
11
12
  as a single validated score.
12
13
 
@@ -39,10 +40,10 @@ of Japanese writing.
39
40
 
40
41
  | File | Contents and role |
41
42
  | --- | --- |
42
- | [prose_benchmark.ja.adoc](../test/fixtures/prose_benchmark.ja.adoc) | 21 paragraphs used as the actual AsciiDoc input |
43
+ | [prose_benchmark.ja.adoc](../test/fixtures/prose_benchmark.ja.adoc) | 26 paragraphs used as the actual AsciiDoc input |
43
44
  | [prose_benchmark.ja.json](../test/fixtures/prose_benchmark.ja.json) | Matching paragraph IDs and text, 11 annotated detector targets, and preservation checklists |
44
45
  | [prose_benchmark.yml](../test/fixtures/prose_benchmark.yml) | Fixed empty configuration that isolates the benchmark from discovered manuscript settings |
45
- | [prose_evaluation.ja.json](../test/fixtures/prose_evaluation.ja.json) | Detection examples and 31 manual revision pairs with expected `accept`, `reject`, or `needs-evidence` dispositions |
46
+ | [prose_evaluation.ja.json](../test/fixtures/prose_evaluation.ja.json) | Detection examples and 43 manual revision pairs with expected `accept`, `reject`, or `needs-evidence` dispositions |
46
47
 
47
48
  The corpus includes framing such as `重要なのは`, metaphorical operations such
48
49
  as `地味に効く`, inflected and negative forms, and repeated endings. Controls
@@ -74,8 +75,18 @@ and policy definition confused with enforcement. Controls retain precise plain
74
75
  verbs or replace relative wording with supported counts and event operations.
75
76
  Unsupported details use `needs-evidence`; contradictions and lost explicit
76
77
  conditions use `reject`. These are original editorial fixtures, not manuscript
77
- excerpts. The 21-paragraph corpus and judge rubric are unchanged, but the changed
78
- calibration fingerprint requires a new AI baseline for comparison.
78
+ excerpts. In version 1.0.2, the 21-paragraph corpus and judge rubric were unchanged,
79
+ but the calibration fingerprint changed and required a new AI baseline.
80
+
81
+ The version 1.0.3 `technical-prose-v3` corpus adds five paragraphs for comparison
82
+ axes, completed/current/planned status, event versus observation dates, known
83
+ actions with unclear state terms, and source uncertainty versus editorial notes.
84
+ Twelve new calibration pairs include faithful revisions, wrong comparisons or
85
+ dates, lost operations, invented change history or failure states, and editing
86
+ markers added to established facts. The five paragraphs add no detector targets
87
+ but do reach the writer and judge. The corpus, calibration, and judge rubric all
88
+ change; establish a fresh AI baseline with those fixed before measuring a review
89
+ criteria change. v1 and v2 results cannot be compared directly with v3.
79
90
 
80
91
  ## What normal tests check
81
92
 
@@ -139,7 +150,7 @@ original 13-paragraph `technical-prose-v1` corpus. Its precision was 100, recall
139
150
  81.818, F1 90, and location accuracy 77.778. Later detector fixes brought the
140
151
  11-target MeCab results to 100 for all four metrics; literal recall remained
141
152
  81.818. Keep that historical report unchanged. It cannot be compared directly
142
- with v2: create a new baseline after expanding the corpus.
153
+ with v2 or v3: create a new baseline after expanding the corpus.
143
154
 
144
155
  ## Compare review criteria with AI trials
145
156
 
@@ -253,5 +264,12 @@ location accuracy were all 100, with zero deltas. The suite passed 203 tests and
253
264
  External AI rewrite-and-judge trials have not yet been run for this change, so
254
265
  its readability and preservation improvement remains unmeasured.
255
266
 
267
+ For the version 1.0.3 yomiyasu v1.0.8 adaptation, detector evaluation on v3 before
268
+ and after the criteria change also retained 100 for all four metrics, with zero
269
+ deltas. The suite passed 209 tests and 2,844 assertions with real MeCab/IPADIC,
270
+ including paragraph and excluded-block boundaries and ordinary line wrapping.
271
+ External AI rewrite-and-judge trials remain unexecuted for this change; these
272
+ results establish detector and workflow regression checks only.
273
+
256
274
  [Development](development.md) · [Manuscript scoring](scoring.md) ·
257
275
  [Back to README](../README.md)
data/docs/references.md CHANGED
@@ -21,6 +21,12 @@ structure, and final edits to the reviewer.
21
21
  and order before and after revision; preserve sentence function separately
22
22
  from plain or polite style. The new examples are original project fixtures.
23
23
  Markdown-specific bold fixes and numeric style thresholds are not imported.
24
+ The 1.0.3 update adapts [v1.0.8, commit 9b9a847](https://github.com/nanaism/yomiyasu/commit/9b9a84757ade524ef9d477f75c6ea13190079f97)
25
+ for comparison axes, tense and event/report dates, and retaining known actions
26
+ when state terms are unclear. Source uncertainty remains in the manuscript;
27
+ editorial questions remain in the separate report. Regression tests preserve
28
+ paragraph boundaries and ordinary line wrapping. These are project-authored
29
+ examples; Markdown-specific scanner and updater implementations are not imported.
24
30
  - [日本語技術文書の文章規範](https://gist.github.com/k16shikano/fd287c3133457c4fd8f5601d34aa817d):
25
31
  informs paragraph logic, evidence scope, and meaningful uncertainty. Applied
26
32
  here: the shared criteria start from each paragraph's technical purpose and
@@ -151,7 +151,7 @@ manuscripts. Numeric title changes
151
151
  are manual-review notices, and remaining candidates do not fail verification.
152
152
  `meaning_verified` remains `false`.
153
153
 
154
- Version 1.0.2 uses session schema 3 and requires the exact tool version saved in
154
+ Version 1.0.3 uses session schema 3 and requires the exact tool version saved in
155
155
  the session. Preserve or finish an ongoing review with its original tool before
156
156
  establishing a new baseline in a separate directory.
157
157
  `review score` continues to support prose only and rejects `--scope`.
@@ -131,13 +131,13 @@ reports analyzer changes instead of treating results from different dictionaries
131
131
  as directly comparable. Prompt generation uses saved evidence and does not need
132
132
  MeCab. Changed rules or dictionary settings require a new scan.
133
133
 
134
- Version 1.0.2 uses session schema 3.
134
+ Version 1.0.3 uses session schema 3.
135
135
  Sessions with a different schema or tool version cannot be loaded. Keep the original baseline for
136
136
  an ongoing review and finish it with the original version, or start a new review
137
137
  pass in a different directory:
138
138
 
139
139
  ```sh
140
- asciidoc-pubkit review scan book.adoc --output .pubkit/review-1.0.2
140
+ asciidoc-pubkit review scan book.adoc --output .pubkit/review-1.0.3
141
141
  ```
142
142
 
143
143
  Severity describes review priority, not proof of an error. There is no AI-authorship
data/docs/writing.md CHANGED
@@ -18,13 +18,20 @@ book explicitly requires one. Sentence splitting and punctuation changes must
18
18
  retain the original relationships; these are contextual review instructions,
19
19
  not automatic semantic checks. Saved sessions retain the criteria from their scan.
20
20
 
21
+ The criteria also preserve the comparison axis, completed changes,
22
+ current behavior, future plans, and the distinction between event dates and
23
+ observation or report dates. An unclear state term does not authorize deleting
24
+ its known action. Keep source-provided undecided or investigation status in the
25
+ body; put reviewer doubts and questions in the separate report, without adding
26
+ editing markers to the manuscript.
27
+
21
28
  ```sh
22
29
  asciidoc-pubkit writing criteria --lang ja
23
30
  asciidoc-pubkit writing prompt --lang ja --output writing-prompt.md
24
31
  ```
25
32
 
26
33
  For example, `--lang en` exits with an unsupported-language error. No English
27
- review or writing criteria are shipped in 1.0.2.
34
+ review or writing criteria are shipped in 1.0.3.
28
35
 
29
36
  For a small trial, use `examples/book.adoc` as the scan input. Its Japanese
30
37
  paragraphs deliberately contain review candidates; its code block must remain
@@ -9,7 +9,7 @@ require 'pathname'
9
9
  require 'optparse'
10
10
 
11
11
  module AsciidocPubkit
12
- VERSION = '1.0.2'
12
+ VERSION = '1.0.3'
13
13
  class Error < StandardError; end
14
14
 
15
15
  def self.hash_text(text)
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: asciidoc-pubkit
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.2
4
+ version: 1.0.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - CyberGarage