Skip to content

Review and improve Japanese manual expressions - #19

Merged
koriym merged 5 commits into
masterfrom
review-ja-expressions
Mar 20, 2026
Merged

koriym merged 5 commits into
masterfrom
review-ja-expressions

Conversation

@koriym

@koriym koriym commented Mar 20, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • 日本語マニュアル全章の表現レビューと改善(17ファイル)
  • 英語版の対応修正(2ファイル)

機械的修正

  • 「Beフレームワーク」→「Be Framework」表記統一
  • 「一次市民」→「第一級市民」用語修正
  • 「コントローラーもオーケストレーターといった」文法修正
  • 一人称「私」混入の除去(03章)
  • ダッシュスタイルの統一

構造改善

  • 03章: 内在/超越の説明を段落分割(概念の洪水を解消)
  • 05章: 型による継続の長文を二文に分割
  • 06章: セクション名「名前の装飾」→「属性による制約の拡張」
  • 06章: #[Validate]の技術的説明を正確化

哲学的表現の調整

  • サルトル引用を日英両方から削除(フレームワークの立場と矛盾するため)
  • 「全能の自由」「無限の責任」の対比構造は維持
  • スピノザ呼応「偶然ではなく、必然」は維持
  • 種子メタファー・植物の比喩は維持

Test plan

  • ./bin/serve.sh でビルドしてリンク切れがないか確認
  • 日本語ページを通読して文体の整合性を確認
  • 英語版 12-philosophy-behind.md のサルトル削除後の流れを確認

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated manual files with terminology standardization (framework naming conventions) and refined sentence structure across English and Japanese sections for improved clarity and consistency.
    • Adjusted explanatory phrasing and emphasis on framework concepts without functional changes.

koriym and others added 5 commits March 20, 2026 11:24
- Fix unnatural/stiff Japanese expressions and split overly long sentences
- Unify "Beフレームワーク" to "Be Framework" across all files
- Fix terminology: "一次市民" → "第一級市民" (first-class citizen)
- Fix grammar: "コントローラーもオーケストレーターといった" → proper particle usage
- Fix style inconsistency: remove first-person "私" in 03-being-classes.md
- Improve technical accuracy: "#[Validate]メソッド" → "#[Validate]属性が付いたメソッド"
- Rename section "名前の装飾" → "属性による制約の拡張" in 06-semantic-variables.md
- Remove Sartre reference in 12-philosophy-behind.md (contradicts framework's position)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- 04a-becoming: Remove duplicated sentence about object lifecycle
- tutorial: Fix repeated "型が意味を持ちます" in same sentence
- 08-reason-layer: Revert "配送方式" back to "存在様式" (generic, not domain-specific)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Restore "全能の自由"/"無限の責任" contrast in 01-overview
- Restore seed metaphor before gardener section in 01-overview
- Restore plant self-transformation language in 01-overview
- Restore "偶然ではなく、必然" echoing Spinoza in 06-semantic-variables
- Restore "何を入れて何が出てくるか" in 04a-becoming
- Restore original Doing/Being contrast in getting-started
- Fix dash inconsistency (hyphen → em dash) in index.md
- Fix noun-phrase style consistency in index.md
- Rewrite confusing "引数にPHP属性がある場合" in 06-semantic-variables

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Restores the contrast with the Commander pattern: commanders
control others, plants transform only themselves.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Remove Sartre reference to match Japanese version (contradicts framework's position)
- Rephrase "no external control such as controllers or orchestrators" for clarity

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Mar 20, 2026 •

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fc5e5636-7816-479e-afda-1e2f98a5ca4e

📥 Commits

Reviewing files that changed from the base of the PR and between 076a2c6 and 399a077.

📒 Files selected for processing (18)
  • manuals/1.0/en/05-metamorphosis-patterns.md
  • manuals/1.0/en/12-philosophy-behind.md
  • manuals/1.0/ja/01-overview.md
  • manuals/1.0/ja/02-input-classes.md
  • manuals/1.0/ja/03-being-classes.md
  • manuals/1.0/ja/04-final-objects.md
  • manuals/1.0/ja/04a-becoming.md
  • manuals/1.0/ja/05-metamorphosis-patterns.md
  • manuals/1.0/ja/06-semantic-variables.md
  • manuals/1.0/ja/08-reason-layer.md
  • manuals/1.0/ja/09-error-handling.md
  • manuals/1.0/ja/10-semantic-logging.md
  • manuals/1.0/ja/12-philosophy-behind.md
  • manuals/1.0/ja/13-vision-ldd.md
  • manuals/1.0/ja/14-faq.md
  • manuals/1.0/ja/demos.md
  • manuals/1.0/ja/index.md
  • manuals/1.0/ja/tutorial.md
💤 Files with no reviewable changes (1)
  • manuals/1.0/en/12-philosophy-behind.md

📝 Walkthrough

Walkthrough

This PR updates documentation across the Be Framework manuals in both English and Japanese. Changes include standardizing terminology ("Beフレームワーク" → "Be Framework"), refining wording and phrasing for clarity, and removing or restructuring explanatory content. No code logic or functionality is affected.

Changes

Cohort / File(s) Summary
English Documentation
manuals/1.0/en/05-metamorphosis-patterns.md, manuals/1.0/en/12-philosophy-behind.md
Tightened phrasing in metamorphosis patterns (em-dash revision), removed explanatory sentence linking Sartre's concept to framework philosophy in the "Designing for Impossibility" section.
Japanese Documentation - Terminology & Overview
manuals/1.0/ja/01-overview.md, manuals/1.0/ja/10-semantic-logging.md, manuals/1.0/ja/index.md
Standardized "Beフレームワーク" to "Be Framework" and refined section descriptions in overview and index with updated phrasing on type-based state changes and conceptual framing.
Japanese Documentation - Core Concepts
manuals/1.0/ja/02-input-classes.md, manuals/1.0/ja/03-being-classes.md, manuals/1.0/ja/04-final-objects.md, manuals/1.0/ja/04a-becoming.md, manuals/1.0/ja/05-metamorphosis-patterns.md, manuals/1.0/ja/06-semantic-variables.md, manuals/1.0/ja/08-reason-layer.md
Refined explanations of input/being/final objects, lifecycle expressions, metamorphosis patterns, semantic validation attributes, and reason layer design with updated terminology and grammatical adjustments.
Japanese Documentation - Error Handling & Logging
manuals/1.0/ja/09-error-handling.md
Clarified domain-layer scope in exception handling guidance by explicitly scoping technical exception restriction to the domain layer.
Japanese Documentation - Philosophy, Vision & Reference
manuals/1.0/ja/12-philosophy-behind.md, manuals/1.0/ja/13-vision-ldd.md, manuals/1.0/ja/14-faq.md, manuals/1.0/ja/demos.md, manuals/1.0/ja/tutorial.md
Updated terminology, removed Sartre sentence reference, rephrased conceptual passages (ontology definitions, gateway descriptions), and refined explanatory text for marker classes and transcendent knowledge without logic changes.

Possibly related PRs

Poem

🐰 Through warren halls of wisdom's craft,
Words dance and settle, clear and bright—
From "フレームワーク" to "Framework," terms align,
Philosophy breathes, concepts take flight,
Documentation blooms in thoughtful light! ✨


🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main objective of the PR, which is a comprehensive review and improvement of Japanese manual expressions across 17 files, with corresponding English manual updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch review-ja-expressions
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@claude

claude Bot commented Mar 20, 2026

Copy link
Copy Markdown

PR Review: Japanese Manual Expression Improvements

This is a documentation-only PR with no code changes. Overall the changes are well-considered and improve clarity and consistency. Here's my detailed feedback:


Strengths

Terminology standardization ✅

  • Beフレームワーク → Be Framework is the right call for a proper name used consistently in English; this unification across all 17 JA files is thorough and correct.

Technical term correction ✅

  • 一次市民 → 第一級市民(first-class citizen) is the established CS translation. The parenthetical English term is helpful for readers who may search for it.

Grammar fix ✅

  • コントローラーもオーケストレーターといった → コントローラーやオーケストレーターのような is a genuine grammatical improvement; the original も usage was ambiguous.

Structural improvements ✅

  • Splitting the immanence/transcendence paragraph in ch.03 into two is a good readability improvement — the original was genuinely dense.
  • The #[Validate] technical description in ch.06 is more accurate: specifying that the attribute must match on both the method argument and the constructor argument is the correct behavior to describe.
  • Section rename 名前の装飾 → 属性による制約の拡張 is a meaningful precision improvement; the original was metaphorical where the section is actually about constraint narrowing.

Philosophical consistency ✅

  • Removing the Sartre quote from both EN and JA makes sense given the PR description's reasoning. Sartre's "existence precedes essence" (existence → then we define ourselves) inverts the framework's stance (what you ARE constrains what you DO), so keeping it risked confusing readers.

Minor Concerns

04a-becoming.md — loss of philosophical nuance
The original:

存在が無になり、無から次の存在が生まれる——この運動がチェーンの終端まで続きます。

was replaced with:

各オブジェクトは次のオブジェクトを生み出すと消滅し、この連鎖が終端まで続きます。

The new version is cleaner prose, but the original's "無になり、無から" (becoming nothing, arising from nothing) was a deliberate philosophical echo of Buddhist/Heraclitean themes that recur throughout the manual. Consider whether this loss of resonance is acceptable, or whether something like 消滅し、その無から次の存在が生まれる could preserve the intent.

03-being-classes.md — first-person removal trade-off
The original:

私を形作り私の一部にはなりますが

was changed to:

オブジェクトを形作りその一部となりますが

The PR description notes this removes 私 (first-person). The substitution is correct technically, but the original's use of 私 was an intentional personification giving readers empathy with the object. If first-person was used elsewhere in the same section as a stylistic choice, consider whether this specific change breaks that voice consistency. (If 私 appeared only in this one sentence accidentally, the fix is appropriate.)

index.md — description simplification
Some section summaries became more concrete but lost conceptual framing:

  • 変容の出発点 - 純粋な内在的本質 → 変容の出発点 — 外部に依存しない純粋なデータ
  • ドメイン固有の検証と存在論的型安全性 → 変数名が意味と検証ルールを持つ仕組み

These are more approachable but trade conceptual precision for accessibility. This is a judgment call — the simpler versions are probably better for first-time readers of the index page.


No Issues Found

  • Bugs: None — documentation only.
  • Security: None.
  • Performance: None.
  • Frontmatter / permalink consistency: Spot-checked; no pages lost category: Manual or had permalink changes that would break language-switching (the EN↔JA /en/↔/ja/ mirror pattern is unaffected).
  • Test plan: The checklist items (./bin/serve.sh build check, readthrough, EN ch.12 flow check) are appropriate for this type of change.

Verdict

The changes are well-executed and net-positive. The main question to resolve before merge is whether the loss of the "無になり、無から" phrasing in 04a-becoming.md is intentional. Everything else is a clear improvement. Recommend merging after confirming that one philosophical nuance point.

@koriym

koriym commented Mar 20, 2026

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Mar 20, 2026

Copy link
Copy Markdown
Contributor
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@koriym
koriym merged commit 8c330ea into master Mar 20, 2026
2 checks passed
@koriym
koriym deleted the review-ja-expressions branch March 20, 2026 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant