Skip to content

docs: オンボーディング資料の「黙って壊れるところ」を言い換え、いちばんに置く理由を書く - #595

Merged
taminororo merged 1 commit into
developfrom
docs/kanba/594/onboarding-no-error-wording
Sep 30, 2026
Merged

taminororo merged 1 commit into
developfrom
docs/kanba/594/onboarding-no-error-wording

Conversation

@taminororo

Copy link
Copy Markdown
Collaborator

対応Issue

resolve #594

概要

docs/development/onboarding.md の言い方と説明を直しました。構成は変えていません。

  • 各節の書き出し「黙って壊れるところ。」(7か所)と、それを指す冒頭・13節の文を「エラーが出ないまま壊れるところ。」に改めました。「黙って」だと、何が起きるのかがすぐには伝わらないためです。起きることをそのまま書きました。本文の中の「黙って捨てます」「黙って無視されます」のような動詞の使い方は、そのままにしています。
  • 冒頭の「この資料でいちばん伝えたいこと」に、それをいちばんに置く理由を3つ書きました。
    • 45th の事故の多くがこの形で起きた。docs/operations/incidents-45th.md の「共通する原因」が、境目で起きることと、失敗が画面に出ないことを挙げている
    • エラーが出ない誤りは、どこで起きうるかを先に知らないと探せない
    • 言語の使い方はチュートリアルで学べるが、SeeFT のどこが危ないかは SeeFT の中でしか学べない

テスト項目

  • grep "黙って壊れ" docs/development/onboarding.md で、古い言い方が残っていないことを確かめた
  • python3 scripts/refcheck/refcheck.py --worktree docs/development/onboarding.md が通ることを確かめた
  • 足したリンク ../operations/incidents-45th.md の先と、見出し「共通する原因」があることを確かめた

備考

@taminororo taminororo self-assigned this Sep 30, 2026
@coderabbitai

coderabbitai Bot commented Sep 30, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 37 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Repository: NUTFes/SeeFT/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 3437d511-4a11-4388-ae18-eee7a2dfbb3f

📥 Commits

Reviewing files that changed from the base of the PR and between 8f960f3 and 5b2262f.

📒 Files selected for processing (1)
  • docs/development/onboarding.md

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.

@taminororo
taminororo merged commit 0413da5 into develop Sep 30, 2026
2 checks passed
@taminororo
taminororo deleted the docs/kanba/594/onboarding-no-error-wording branch September 30, 2026 07:53
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.

docs: オンボーディング資料の「黙って壊れるところ」の言い方を直し、いちばんに置く理由を書く

1 participant