asciidoc-pubkit 1.0.3 → 1.2.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +73 -0
- data/README.md +50 -5
- data/data/heading-rules.ja.yml +4 -0
- data/data/review-rules.ja.yml +14 -4
- data/data/writing/ja/criteria.md +98 -1
- data/data/writing/ja/headings.md +11 -0
- data/data/writing/ja/outline.md +23 -0
- data/docs/agent-review-tutorial.md +312 -0
- data/docs/configuration.md +6 -0
- data/docs/document-commands.md +6 -1
- data/docs/installation.md +19 -2
- data/docs/outline-review.md +110 -0
- data/docs/prose-evaluation.md +25 -3
- data/docs/review-workflow.md +49 -1
- data/docs/rules-and-coverage.md +13 -2
- data/docs/skill-commands.md +136 -0
- data/docs/skill-integration.md +190 -0
- data/docs/writing.md +18 -1
- data/examples/skills/review-asciidoc-manuscript/SKILL.md +56 -0
- data/lib/asciidoc_pubkit/cli.rb +15 -2
- data/lib/asciidoc_pubkit/document.rb +11 -2
- data/lib/asciidoc_pubkit/document_commands.rb +32 -2
- data/lib/asciidoc_pubkit/heading_rules.rb +1 -0
- data/lib/asciidoc_pubkit/rules.rb +14 -0
- data/lib/asciidoc_pubkit/session.rb +45 -3
- data/lib/asciidoc_pubkit/settings.rb +12 -1
- data/lib/asciidoc_pubkit/skill_commands.rb +246 -0
- data/lib/asciidoc_pubkit/writing.rb +5 -0
- data/lib/asciidoc_pubkit.rb +2 -1
- metadata +8 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6148912a889b61a943c121c307ae696c49f861f7cb734265af0b1a9333d50966
|
|
4
|
+
data.tar.gz: ce07e6f2d66c7ab3e23a8dd39325b297f9f3d3f6c715fb001c2604052307f999
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a08ca5477ee8785bbe7623a108e2cd22ad8c1f4c6900e7500d446502674007db5b29192c9e02abdeacb931a26a78a45070b6f19b57c0de51c4bd20d2da884afe
|
|
7
|
+
data.tar.gz: ee0b90c82c362f7b0da5b1807cf187ad2d330c24a5ce11cfa599f25d50c35fa99814bb154d148f3b747c87bfeaf965dea76f22e283e8e2d53685341203239bf7
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,78 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## Unreleased
|
|
4
|
+
|
|
5
|
+
## 1.2.0 - 2026-10-12
|
|
6
|
+
|
|
7
|
+
- Require concrete alternative comparisons for broad or everyday wording in
|
|
8
|
+
shared Japanese criteria, candidate questions and review prompts. Distinguish
|
|
9
|
+
understandable wording from an editorial keep decision; prohibit automatic
|
|
10
|
+
keep records and inherited paragraph summaries in reporting helpers. Add
|
|
11
|
+
terminology examples for safety margins and tree structures while preserving
|
|
12
|
+
formal names, values and factual scope. Verification remains mechanical.
|
|
13
|
+
|
|
14
|
+
- Add `流れ` as an `abstract-reference` hint for prose and list text in MeCab
|
|
15
|
+
and literal modes. Extend shared criteria to identify processing order,
|
|
16
|
+
information transfer, invocation paths, work procedures and state changes;
|
|
17
|
+
compare concrete alternatives and reject interchangeable technical-term substitutions.
|
|
18
|
+
Add four revision calibration pairs (59 total) and regression coverage for
|
|
19
|
+
positions, exclusions, custom rules, prompt delivery and unchanged sources.
|
|
20
|
+
Existing sessions retain their saved rules and criteria; no automatic
|
|
21
|
+
replacement or semantic verification is added.
|
|
22
|
+
|
|
23
|
+
- Add sentence-ending decisions to the shared Japanese criteria, with contextual
|
|
24
|
+
revision and keep examples for scope guides, operations, capabilities, checks,
|
|
25
|
+
comparisons, uncertainty, and history. Separate body predicates from heading
|
|
26
|
+
form and preserve negation strength. Add twelve revision calibration pairs
|
|
27
|
+
(55 total), update the judge rubric, and retain saved-session criteria.
|
|
28
|
+
Detector terms, automatic replacements, and verification semantics are unchanged;
|
|
29
|
+
no AI proofreading improvement has been measured.
|
|
30
|
+
|
|
31
|
+
- Add `--agent codex|claude` to skill install, status and upgrade for local
|
|
32
|
+
project registration in `.agents/skills` or `.claude/skills`. Keep `--dir`
|
|
33
|
+
for custom destinations; reject combining both options. Both agents receive
|
|
34
|
+
the same Agent Skills format, without invoking an agent or changing settings.
|
|
35
|
+
|
|
36
|
+
- Add local bundled-skill list, install, status and upgrade commands with explicit
|
|
37
|
+
destinations, version/hash registration, local-change and downgrade protection,
|
|
38
|
+
staged replacement and restoration on failure. No AI invocation, network skill
|
|
39
|
+
fetching or review-baseline mutation is added. Update the tutorials to register
|
|
40
|
+
and maintain skills with these commands instead of manual copying.
|
|
41
|
+
|
|
42
|
+
- Rewrite the CLI tutorial and skill integration guide for arbitrary AsciiDoc
|
|
43
|
+
book projects. Replace publisher-specific paths with generic single-file and
|
|
44
|
+
included-chapter examples, make project instructions and review records optional,
|
|
45
|
+
and retain the current Japanese-review language boundary.
|
|
46
|
+
|
|
47
|
+
## 1.1.0 — 2026-10-08
|
|
48
|
+
|
|
49
|
+
- Add an illustrated agent-review tutorial with a reproducible sample, diagnosis
|
|
50
|
+
and revision handoffs, separate heading/prose/list phases, verification recovery,
|
|
51
|
+
and a CyberGarage book workflow example. Add a skill integration guide and
|
|
52
|
+
packaged minimal SKILL.md example. Keep model review externally initiated
|
|
53
|
+
and distinguish mechanical preservation from editorial completion.
|
|
54
|
+
|
|
55
|
+
- Add `document toc --json` with parsed/source titles, outline positions, parent
|
|
56
|
+
relationships, section IDs and source cursor locations; keep text output unchanged.
|
|
57
|
+
- Add heading-only `review scan --depth N` and `review.heading_depth` configuration.
|
|
58
|
+
Save the selection limit, retain the full reference outline/body context, protect
|
|
59
|
+
deeper titles, and reject reused titles before filtering by depth.
|
|
60
|
+
- Add heading-session `review prompt --view outline` with whole-outline criteria,
|
|
61
|
+
numbered navigation and editable/reference-only labels. Freeze the criteria at
|
|
62
|
+
scan time; old sessions keep full prompts and verification, and require a fresh
|
|
63
|
+
baseline in a different directory for outline view. No automatic editing, model
|
|
64
|
+
invocation, decision validation or structural-edit permission is added.
|
|
65
|
+
|
|
66
|
+
- Add evidence-based human-role criteria and heading/body terminology alignment.
|
|
67
|
+
Keep developer, user, evaluator, author, and human-versus-AI meanings distinct
|
|
68
|
+
without prescribing occupations, permissions, or automatic replacements.
|
|
69
|
+
- Add standalone 人 review hints for prose, list text, and headings, excluding
|
|
70
|
+
compounds and counts in MeCab and literal modes. Preserve allow lists, inline
|
|
71
|
+
protection, custom rule precedence, and existing saved-session baselines.
|
|
72
|
+
- Clarify task-specific versus general editorial coverage and separately
|
|
73
|
+
authorized table, figure, and alternative-text synchronization. No new CLI
|
|
74
|
+
selection filter, decision validation, or semantic verification is added.
|
|
75
|
+
|
|
3
76
|
## 1.0.3 — 2026-10-07
|
|
4
77
|
|
|
5
78
|
- Adapt yomiyasu v1.0.8 guidance to preserve comparison axes, completed/current/
|
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
|
|
19
|
+
Version 1.2.0 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,11 +26,11 @@ 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.
|
|
29
|
+
The following commands are available in version 1.2.0.
|
|
30
30
|
|
|
31
31
|
| Feature | Commands | Behavior |
|
|
32
32
|
| --- | --- | --- |
|
|
33
|
-
| [Document outline](docs/document-commands.md#document-commands) | `document toc` | Print parsed section titles, including
|
|
33
|
+
| [Document outline](docs/document-commands.md#document-commands) | `document toc` | Print parsed section titles as text or JSON, including source locations, with optional depth and outline numbering |
|
|
34
34
|
| [Book metadata](docs/document-commands.md#document-commands) | `document info` | Extract book attributes as text or JSON |
|
|
35
35
|
| [Cross-reference checks](docs/document-commands.md#document-commands) | `document check-xrefs` | Report unresolved local cross-references with source locations |
|
|
36
36
|
| [Document-title index](docs/document-commands.md#document-commands) | `document index` | Generate an alphabetical AsciiDoc index from English document titles and IDs |
|
|
@@ -43,6 +43,24 @@ The following commands are available in version 1.0.3.
|
|
|
43
43
|
| [Baseline verification](docs/review-workflow.md#verify) | `review verify` | Check edited sources against a saved baseline for mechanical preservation; meaning is not verified |
|
|
44
44
|
| [Manuscript scoring](docs/scoring.md#score-an-asciidoc-manuscript) | `review score` | Report a prose candidate-density score; explicit `--agent codex` or `--agent claude` optionally invokes a local AI CLI for readability ratings |
|
|
45
45
|
| [Writing criteria and prompts](docs/writing.md#writing-commands) | `writing criteria`, `writing prompt` | Print Japanese prose criteria or generate a writing prompt without a manuscript or MeCab |
|
|
46
|
+
| [Skill registration](docs/skill-commands.md) | `skill list`, `skill install`, `skill status`, `skill upgrade` | Register bundled skills for Codex or Claude and inspect or upgrade managed copies while protecting local changes |
|
|
47
|
+
|
|
48
|
+
The 1.2.0 [sentence-ending guidance](docs/writing.md#writing-commands)
|
|
49
|
+
adds contextual revision and keep examples, preserving capabilities, uncertainty,
|
|
50
|
+
comparison strength, and body sentences separately from heading form. It adds
|
|
51
|
+
no detector terms or automatic replacements; development calibration includes
|
|
52
|
+
59 pairs, without a measured claim of improved AI proofreading.
|
|
53
|
+
|
|
54
|
+
The 1.2.0 [default rules](docs/rules-and-coverage.md) add `流れ` as an
|
|
55
|
+
`abstract-reference` hint for prose and list text. Review processing order,
|
|
56
|
+
information transfer and state changes in context; compare concrete alternatives and
|
|
57
|
+
prefer accurate technical terms without automatic substitutions. Existing sessions keep their saved
|
|
58
|
+
rules and criteria; start a new scan to use the update.
|
|
59
|
+
|
|
60
|
+
Version 1.2.0 also requires comparison with concrete alternatives for broad or
|
|
61
|
+
everyday wording. Review prompts reject automatic keep judgments and passage
|
|
62
|
+
summaries used as candidate decisions; missing comparisons remain pending.
|
|
63
|
+
Verification continues to check mechanical preservation only.
|
|
46
64
|
|
|
47
65
|
Version 1.0.1 extended the [shared writing criteria](docs/writing.md#writing-commands)
|
|
48
66
|
with structural comparison before and after revision and preservation of sentence
|
|
@@ -53,6 +71,24 @@ Version 1.0.3 additionally preserves comparison axes, temporal roles,
|
|
|
53
71
|
and known actions in unclear passages, separating source uncertainty from editorial
|
|
54
72
|
questions. The evaluation guide describes the expanded corpus and calibration.
|
|
55
73
|
|
|
74
|
+
Version 1.1.0 adds contextual human-role guidance and standalone `人`
|
|
75
|
+
review hints, with terminology alignment and task-specific coverage reporting.
|
|
76
|
+
These remain advisory; they do not automatically replace manuscript words or
|
|
77
|
+
expand the protected edit scopes. See the [review workflow](docs/review-workflow.md).
|
|
78
|
+
|
|
79
|
+
Version 1.1.0 also adds [outline review](docs/outline-review.md) with `document toc --json`,
|
|
80
|
+
`review scan --scope headings --depth N`, and `review prompt --view outline`.
|
|
81
|
+
Review subject coverage, heading granularity and terminology with saved body
|
|
82
|
+
evidence while protecting deeper titles, structure and section IDs. Full prompts
|
|
83
|
+
and unlimited heading selection remain the defaults.
|
|
84
|
+
|
|
85
|
+
Version 1.2.0 [skill commands](docs/skill-commands.md) add `skill list`,
|
|
86
|
+
`skill install NAME --agent codex|claude`, `skill status` and `skill upgrade`.
|
|
87
|
+
Use `--dir PATH` instead for a custom destination. Register a
|
|
88
|
+
bundled review skill, inspect its state and update unchanged copies from the
|
|
89
|
+
running pubkit package. Local changes and unmanaged copies stay protected.
|
|
90
|
+
These commands are included in the 1.2.0 gem.
|
|
91
|
+
|
|
56
92
|
## Requirements and scope
|
|
57
93
|
|
|
58
94
|
Ruby 3.2 or later is required; RubyGems installs Asciidoctor and the other Ruby
|
|
@@ -85,11 +121,16 @@ asciidoc-pubkit --help
|
|
|
85
121
|
```
|
|
86
122
|
|
|
87
123
|
To update, run `gem update asciidoc-pubkit`. For Bundler, add
|
|
88
|
-
`gem 'asciidoc-pubkit', '~> 1.0
|
|
124
|
+
`gem 'asciidoc-pubkit', '~> 1.2.0'` to your project's `Gemfile` and run commands
|
|
89
125
|
through `bundle exec`. See [source installation and local checkout usage](docs/installation.md).
|
|
90
126
|
|
|
91
127
|
## Quick start
|
|
92
128
|
|
|
129
|
+
Follow the [agent review tutorial](docs/agent-review-tutorial.md) for a complete
|
|
130
|
+
scan, prompt, Codex/Claude handoff, revision and verification walkthrough.
|
|
131
|
+
For a reusable agent workflow, see [skill integration](docs/skill-integration.md).
|
|
132
|
+
|
|
133
|
+
|
|
93
134
|
Run these commands from the manuscript directory:
|
|
94
135
|
|
|
95
136
|
```sh
|
|
@@ -125,7 +166,7 @@ asciidoc-pubkit writing prompt --lang ja --output writing-prompt.md
|
|
|
125
166
|
|
|
126
167
|
Existing review sessions require the exact tool version that created them.
|
|
127
168
|
Before upgrading, finish ongoing reviews with that version or preserve their
|
|
128
|
-
baselines and start a new review in a separate directory with v1.0.
|
|
169
|
+
baselines and start a new review in a separate directory with v1.2.0. A new
|
|
129
170
|
scan cannot verify preservation relative to an earlier baseline.
|
|
130
171
|
|
|
131
172
|
## Documentation
|
|
@@ -134,7 +175,11 @@ scan cannot verify preservation relative to an earlier baseline.
|
|
|
134
175
|
| --- | --- |
|
|
135
176
|
| [Installation](docs/installation.md) | RubyGems, Bundler, source, local checkout, MeCab/IPADIC |
|
|
136
177
|
| [Document commands](docs/document-commands.md) | Outline, metadata, cross-references, English-title indexes |
|
|
178
|
+
| [Outline review](docs/outline-review.md) | JSON outline, heading-depth selection, whole-outline prompts and preservation |
|
|
137
179
|
| [Prose replacements](docs/replacements.md) | Rule format, imports, regex compatibility, preview/apply, preservation |
|
|
180
|
+
| [Skill commands](docs/skill-commands.md) | List/install/status/upgrade, managed files, local changes and recovery |
|
|
181
|
+
| [Skill integration](docs/skill-integration.md) | Register and maintain a skill, then orchestrate review in any book project |
|
|
182
|
+
| [Agent review tutorial](docs/agent-review-tutorial.md) | Illustrated first review, agent instructions, sequential scopes and verification recovery |
|
|
138
183
|
| [Review workflow](docs/review-workflow.md) | Scanning, heading review, prompts, sessions, verification, exit codes |
|
|
139
184
|
| [List review](docs/list-review.md) | Separate list sessions, editable items, protected syntax |
|
|
140
185
|
| [Scoring](docs/scoring.md) | Candidate density, optional AI readability ratings, output |
|
data/data/heading-rules.ja.yml
CHANGED
|
@@ -14,6 +14,10 @@ terms:
|
|
|
14
14
|
- さまざまなこと
|
|
15
15
|
- 入口
|
|
16
16
|
question: 'Check whether the heading identifies the actual subject, operation or comparison. Use the section as evidence; apply the shared role-metaphor criteria to 入口 and preserve section IDs. Do not invent missing specificity.'
|
|
17
|
+
heading-human-role:
|
|
18
|
+
terms:
|
|
19
|
+
- 人
|
|
20
|
+
question: 'Identify the supported human role from the section. Consider developer, user, evaluator, author, or human-versus-AI wording only from evidence; keep general populations and established autonomy measures. Do not automatically replace 人 with 開発者.'
|
|
17
21
|
fixed_titles:
|
|
18
22
|
- はじめに
|
|
19
23
|
- 本書の構成
|
data/data/review-rules.ja.yml
CHANGED
|
@@ -14,7 +14,10 @@ terms:
|
|
|
14
14
|
# Components, actors, and hierarchical relationships.
|
|
15
15
|
- 構成要素
|
|
16
16
|
- 部品
|
|
17
|
+
# Sequences, transfers, and state changes require contextual review.
|
|
18
|
+
- 流れ
|
|
17
19
|
- 開発者
|
|
20
|
+
- 人
|
|
18
21
|
- 祖先
|
|
19
22
|
- 子孫
|
|
20
23
|
# Scope, separation, and organization.
|
|
@@ -36,10 +39,15 @@ terms:
|
|
|
36
39
|
- 余白
|
|
37
40
|
# Event or operation wording requires context, not a fixed synonym.
|
|
38
41
|
- 発火
|
|
39
|
-
question: Identify the concrete referent, components, role, or measurable work
|
|
42
|
+
question: Identify the concrete referent, components, role, or measurable work,
|
|
43
|
+
then compare a concrete expression or established technical term using the shared
|
|
44
|
+
criteria. Recoverable meaning alone does not justify keeping broad wording.
|
|
40
45
|
For 入口, apply the shared role-metaphor criteria; a clear referent alone is
|
|
41
46
|
not a sufficient reason to keep vague operation wording. Keep
|
|
42
|
-
established technical meanings. For
|
|
47
|
+
established technical meanings. For standalone 人, identify the supported
|
|
48
|
+
human role; consider developer, user, evaluator, author, or human-versus-AI
|
|
49
|
+
wording only from evidence. Keep general populations and established
|
|
50
|
+
autonomy measures; do not automatically replace 人 with 開発者. For 木 and 余白, consider a context-appropriate
|
|
43
51
|
katakana term (such as ツリー or マージン) only when it names the intended concept.
|
|
44
52
|
weak-predicate:
|
|
45
53
|
terms:
|
|
@@ -139,8 +147,10 @@ terms:
|
|
|
139
147
|
- 終えられます
|
|
140
148
|
- 抜けられます
|
|
141
149
|
- 解消する
|
|
142
|
-
question:
|
|
143
|
-
|
|
150
|
+
question: Identify the purpose, operation, and result, then compare a more precise
|
|
151
|
+
verb or established technical term using the shared criteria. An understandable
|
|
152
|
+
original is not by itself a reason to keep it. Record the alternative and the
|
|
153
|
+
passage-specific comparison. Preserve negation, conditions, and responsibility.
|
|
144
154
|
vague-degree:
|
|
145
155
|
terms:
|
|
146
156
|
- 浅い
|
data/data/writing/ja/criteria.md
CHANGED
|
@@ -3,10 +3,12 @@
|
|
|
3
3
|
## Contents
|
|
4
4
|
|
|
5
5
|
- Start with the paragraph's technical purpose
|
|
6
|
+
- Identify human actors by their supported roles
|
|
6
7
|
- Replace abstraction with the thing being discussed
|
|
7
8
|
- Give weak predicates a concrete action or consequence
|
|
8
9
|
- Explain metaphorical operations from evidence
|
|
9
10
|
- Distinguish instructions, behavior, and capabilities
|
|
11
|
+
- Review sentence endings by their role
|
|
10
12
|
- Make relationships explicit
|
|
11
13
|
- Compare structure before and after revision
|
|
12
14
|
- Keep claims within their evidence and purpose
|
|
@@ -34,9 +36,43 @@ individual phrases. A short sentence is not automatically clear; omitted
|
|
|
34
36
|
subjects, objects, complements, and referents must still be recoverable from the
|
|
35
37
|
adjacent sentences.
|
|
36
38
|
|
|
39
|
+
## Identify human actors by their supported roles
|
|
40
|
+
|
|
41
|
+
Treat `人` as a cue to identify the actor, not as a forbidden word or a
|
|
42
|
+
replacement instruction. Determine who performs the operation from the
|
|
43
|
+
paragraph, neighboring context, and source evidence before naming a role.
|
|
44
|
+
|
|
45
|
+
| Supported role in the passage | Possible wording |
|
|
46
|
+
| --- | --- |
|
|
47
|
+
| Designing or implementing a system, test, or execution environment | 開発者・設計者 |
|
|
48
|
+
| Requesting work, operating a UI, approving an operation, or selecting a workflow | 利用者・ユーザー |
|
|
49
|
+
| Reviewing samples or calibrating scoring criteria | 評価担当者 |
|
|
50
|
+
| Authoring a document whose authority is being discussed | 文書の作成者 |
|
|
51
|
+
| Contrasting human judgment with a model or program | 人間・人間側 |
|
|
52
|
+
|
|
53
|
+
These are context-dependent examples, not a mandatory glossary. Follow the
|
|
54
|
+
book's established terms. A developer can also be a user; these role names do
|
|
55
|
+
not imply separate people, new permissions, qualifications, or staffing.
|
|
56
|
+
Do not infer `開発者` merely because the book concerns software. For example,
|
|
57
|
+
`人が候補を選ぶ` can become `利用者が候補を選ぶ` when the application displays
|
|
58
|
+
candidates for selection, while constructing those candidates can be a developer's
|
|
59
|
+
role. A role change must not narrow who may perform the documented operation.
|
|
60
|
+
|
|
61
|
+
Keep general populations, established research terminology, and human-versus-AI
|
|
62
|
+
comparisons when specificity would change their scope. `人の介入` can name a
|
|
63
|
+
measure of autonomy, and `多くの人` need not mean only developers. Do not treat
|
|
64
|
+
`個人`, `人数`, or `3人` as ambiguous actor wording. If the actor cannot be
|
|
65
|
+
established, record the missing evidence rather than assigning an occupation.
|
|
66
|
+
When an actor is unnecessary, state the concrete form instead: a displayed table
|
|
67
|
+
may be described as `表形式` instead of `人が読みやすい形`.
|
|
68
|
+
|
|
37
69
|
## Replace abstraction with the thing being discussed
|
|
38
70
|
|
|
39
71
|
Identify both the referent and its role before retaining an abstract term.
|
|
72
|
+
Understandability is an initial factual check, not a keep decision. For broad or
|
|
73
|
+
everyday wording, compare a concrete alternative and prefer an accurate established
|
|
74
|
+
technical term that narrows the intended meaning. Record the alternative and the
|
|
75
|
+
specific benefit or loss; a summary of the passage does not establish this comparison.
|
|
40
76
|
A named API, file, or command can make the referent recoverable while leaving
|
|
41
77
|
its operation vague. Inspect terms such as:
|
|
42
78
|
|
|
@@ -47,12 +83,29 @@ its operation vague. Inspect terms such as:
|
|
|
47
83
|
| 境界 | the two components and the call, data transfer, or ownership transfer between them |
|
|
48
84
|
| 観点 | the actual comparison axis, such as type safety, shutdown behavior, allocation count, or supported OS |
|
|
49
85
|
| 書き方 | syntax, implementation technique, API shape, or document notation |
|
|
86
|
+
| 流れ | processing order, information transfer, invocation path, work procedure, or state changes |
|
|
50
87
|
| 範囲・射程 | supported readers, covered subjects, applicable versions, or behavior guaranteed by an API |
|
|
51
88
|
|
|
52
89
|
Do not improve a sentence by replacing one abstraction with another. For
|
|
53
90
|
example, changing `費用` to `コスト` says nothing unless the sentence identifies
|
|
54
91
|
what increases.
|
|
55
92
|
|
|
93
|
+
Treat `流れ` as a cue to identify the described operation, not as a banned word.
|
|
94
|
+
Even when the actors, transferred information, order, or conditions are clear,
|
|
95
|
+
compare a more exact expression for the supported relationship. Prefer that
|
|
96
|
+
expression when it clarifies the technical role; keep the original only with
|
|
97
|
+
a specific comparison showing no improvement or a loss of scope. Examples include
|
|
98
|
+
`処理順`, `情報の受け渡し`, `呼び出し経路`, or `作業手順`.
|
|
99
|
+
Changing `流れ` to `処理フロー` alone does not add specificity. Use `シーケンス`
|
|
100
|
+
for the order of calls or events, `データフロー` for data transfers and
|
|
101
|
+
transformations, and `ライフサイクル` for creation, execution, termination or
|
|
102
|
+
release only when those are the actual subject. These terms are not interchangeable;
|
|
103
|
+
do not invent missing stages, narrow an explanation to data alone, or lose a
|
|
104
|
+
branch condition merely to make the wording more technical. For example,
|
|
105
|
+
`検査に成功した後だけ、実行関数を呼び出す流れです` already states the
|
|
106
|
+
operation, order and condition and can remain unchanged only after comparing
|
|
107
|
+
a direct description of that conditional invocation and finding no useful improvement.
|
|
108
|
+
|
|
56
109
|
For role metaphors such as `入口`, check whether naming the actual operation or
|
|
57
110
|
relationship gives the reader more useful information, even when the referent
|
|
58
111
|
is already clear. Consider these alternatives only when evidence supports them:
|
|
@@ -179,6 +232,49 @@ require polite style. Resolve unintended style mixing separately from each
|
|
|
179
232
|
sentence's function; changing `する` to `します` must not change advice into
|
|
180
233
|
an asserted operation. Do not vary endings just to make these functions uniform.
|
|
181
234
|
|
|
235
|
+
## Review sentence endings by their role
|
|
236
|
+
|
|
237
|
+
Read the complete sentence and neighboring sentences before judging its ending.
|
|
238
|
+
First identify whether it announces the section's scope, describes an actual
|
|
239
|
+
operation, offers a capability, gives a checking procedure, or reports history
|
|
240
|
+
or a future expectation. Then name its actor, object, condition, and consequence.
|
|
241
|
+
Revise only when a more direct explanation preserves those relationships;
|
|
242
|
+
otherwise retain the original wording and explain its role.
|
|
243
|
+
|
|
244
|
+
| Ending and context | Decision to consider |
|
|
245
|
+
| --- | --- |
|
|
246
|
+
| `注目します`, `明らかにします`, `確認します`, or `たどります` in an introduction | Keep a useful scope or reading-order guide. If it only repeats an announcement, state the supported comparison, operation, or question directly; do not invent its answer. |
|
|
247
|
+
| `戻します` or `組み立てます` in an operation description | Keep it when the transferred result, recipient, or constructed input is clear. Do not replace it with a noun or jargon merely to vary the ending. |
|
|
248
|
+
| `使えます`, `組み込めます`, `選べます`, or `作れます` | Preserve the available option and its conditions. Changing to `使います` or `選びます` can falsely assert actual or automatic execution. |
|
|
249
|
+
| `分かりません` | Identify whether the missing evidence prevents judgment, confirmation, or identification. Use `判断できません` or `確認できません` only when that operation fits; preserve what remains unknown. |
|
|
250
|
+
| `別です` or `同じではありません` | Name the compared objects and the property, purpose, or evidence that differs. Distinguish definite non-identity from insufficient evidence to infer a result. |
|
|
251
|
+
| `確認します` or `調べます` in a procedure | Keep an actual check, including its target, condition, and timing. Do not turn it into a capability or a claim that the check succeeded. |
|
|
252
|
+
| `移りました` or another past ending | Keep a supported historical transition distinct from current behavior or a future plan. |
|
|
253
|
+
|
|
254
|
+
For example, `会話形式の画面だけでは、実行できる操作の範囲は分かりません`
|
|
255
|
+
can become `会話形式の画面だけでは、実行できる操作の範囲を判断できません`.
|
|
256
|
+
Both retain the missing evidence and the same judgment target. By contrast,
|
|
257
|
+
`処理結果が分かりません` cannot become `処理は失敗しました`: an unknown
|
|
258
|
+
outcome is not an established failure.
|
|
259
|
+
|
|
260
|
+
Retain `利用者は候補Aと候補Bから選べます` when it states an available choice;
|
|
261
|
+
`利用者は候補Aと候補Bから選びます` would assert that selection occurs. Retain
|
|
262
|
+
`実行側はツール結果をモデルへ戻します` when it describes the transfer;
|
|
263
|
+
`実行結果のフィードバック` would lose the sentence's actor and predicate.
|
|
264
|
+
|
|
265
|
+
Do not mechanically convert `別です` to `とは限りません`. For example,
|
|
266
|
+
`AはJSONを、BはCSVを受け付けます。両者の入力形式は別です` establishes a
|
|
267
|
+
definite difference. Changing the last sentence to `両者の入力形式が同じとは
|
|
268
|
+
限りません` weakens that claim. When an event merely fails to establish another
|
|
269
|
+
result, such as completion failing to establish test success, state that
|
|
270
|
+
inference limit while retaining the original scope and strength of negation.
|
|
271
|
+
|
|
272
|
+
Heading form and running-prose grammar are separate decisions. A project's
|
|
273
|
+
noun-phrase heading policy does not authorize nominalizing body sentences or
|
|
274
|
+
removing their predicates. A proposed ending alone cannot supply new subjects,
|
|
275
|
+
mechanisms, constraints, or guarantees; obtain those from the actual passage
|
|
276
|
+
and its evidence. Record meaningful keep decisions as well as revisions.
|
|
277
|
+
|
|
182
278
|
## Make relationships explicit
|
|
183
279
|
|
|
184
280
|
Inspect a sentence when it:
|
|
@@ -356,7 +452,8 @@ Review unusual translations against the actual concept:
|
|
|
356
452
|
|
|
357
453
|
| Wording to inspect | Context-dependent terminology |
|
|
358
454
|
| --- | --- |
|
|
359
|
-
| 木 |
|
|
455
|
+
| 木 | ツリー構造・ツリー when referring to the data structure; preserve formal names such as モンテカルロ木探索 and literal or mathematical uses |
|
|
456
|
+
| 安全余白 | 安全マージン when naming the reserved allowance for estimation or counting differences; retain its unit, value, and calculation |
|
|
360
457
|
| 拡張点 | 拡張ポイント for the specific extension location or interface; 拡張機構 for the broader mechanism only when that is the intended referent |
|
|
361
458
|
| 構築入口 | ビルドのエントリポイント only when the entry point starts a build, not object construction or initialization |
|
|
362
459
|
| 実装の読解 | コードリーディング for reading code; 実装の解析 when analysis is the actual task |
|
data/data/writing/ja/headings.md
CHANGED
|
@@ -34,6 +34,17 @@ sections and procedures can intentionally use different forms.
|
|
|
34
34
|
Repeated official terms and fixed section names are valid. Check duplicate
|
|
35
35
|
siblings for ambiguity, without treating all repetition as a defect.
|
|
36
36
|
|
|
37
|
+
## Follow terminology changes through the section
|
|
38
|
+
|
|
39
|
+
When a heading introduces a technical term or clarifies a human role, check
|
|
40
|
+
that the body uses it for the same operation and scope. Compare headings with
|
|
41
|
+
the same role without making every section equally technical or equally long.
|
|
42
|
+
Apply the shared human-actor criteria: `人の確認` may refer to a user's approval,
|
|
43
|
+
an evaluator's review, or a general human-versus-AI distinction. Do not choose
|
|
44
|
+
`開発者` solely from the book's subject. In a heading session, body text remains
|
|
45
|
+
read-only; record needed body, table, figure, or alternative-text updates as
|
|
46
|
+
separate proposals rather than changing them with the title.
|
|
47
|
+
|
|
37
48
|
## Respect the book's format
|
|
38
49
|
|
|
39
50
|
The book owns preferred nominal or action forms, questions, fixed titles,
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
## Whole-outline assessment
|
|
2
|
+
|
|
3
|
+
Start with the book's intended readers, prerequisites, purpose and requested scope.
|
|
4
|
+
Compare parts, chapters, parents, siblings and descendants before proposing title edits.
|
|
5
|
+
Check subject coverage, reading order, granularity, terminology and distinctions between
|
|
6
|
+
conceptual explanation, standards/research, comparisons and implementation where relevant.
|
|
7
|
+
These roles are book-specific; do not impose the same chapter pattern or heading style.
|
|
8
|
+
Follow the saved heading rules and book instructions; nominal preferences do not justify
|
|
9
|
+
losing actors, objects, conditions, order or distinctions.
|
|
10
|
+
Technical keywords must identify material actually explained. Do not turn input construction
|
|
11
|
+
into an optimization guarantee or format convergence into a formal standard without evidence.
|
|
12
|
+
|
|
13
|
+
The outline is navigation evidence, not proof that a title matches its section.
|
|
14
|
+
Read the body context in this same prompt, including relevant descendants, before deciding.
|
|
15
|
+
Where omitted tables, figures, code or other sources are needed, record needs-evidence and
|
|
16
|
+
the required follow-up; do not invent support from the title or introduction alone.
|
|
17
|
+
Distinguish selected editable titles from reference-only titles and covered source positions.
|
|
18
|
+
Record each selected heading ID, current title, proposed title, keep/revise/needs-evidence,
|
|
19
|
+
reason, body evidence and any separate body/table/figure synchronization proposal.
|
|
20
|
+
Review coverage is the selected headings, not every heading visible in the outline.
|
|
21
|
+
Chapter moves, merges, splits and hierarchy changes are separate structure proposals only;
|
|
22
|
+
this view does not expand edit permissions or relax baseline verification.
|
|
23
|
+
Verification remains mechanical and keeps meaning_verified: false.
|