otnc/skills_japanese-style / skills/japanese-style
japanese-style
Verified日本語の回答、進捗報告、手順、要約、ドキュメント、コードコメント、コミットメッセージや PR の説明を書く・直すときに、文章の構成、文体、用語、表記を整える。「日本語で答えて」「日本語でまとめて」「日本語を校正して」などの依頼や、読点「、」の打ちすぎ・位置、曖昧な主語、翻訳調、図表の説明、不自然な漢字訳、文字化けを確認するときに使う。
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 7.1 KB |
| references/commas.md | markdown | 10.1 KB |
| references/kangxi-radicals.md | markdown | 10.1 KB |
| references/terminology.md | markdown | 7.8 KB |
| references/writing-examples.md | markdown | 3.7 KB |
| references/writing-guide.md | markdown | 7.9 KB |
| scripts/lint.js | script | 7.1 KB |
| scripts/package.json | manifest | 23 B |
references/writing-examples.md
View on GitHub# 日本語の修正例
## 会話と進捗報告
想定する場面は、日本語のやり取りの途中で、CI が `Error: Missing environment variable API_URL` を返したとき。
- 修正前「The CI job failed because API_URL is missing.」
- 修正後「CI は `API_URL` が未設定で止まったよ。ログには `Error: Missing environment variable API_URL` と出ている。」
原因の説明は会話の言語に合わせる。ログは、読み手が同じエラーを検索できるよう原文を引用する。
設定方法を聞かれたら、必要な操作から答える。操作が環境によって変わる場合は、どの環境に当てはまるかを同じ段落に書く。
- 修正前「環境に応じて、適切な設定をしていただく形になります。」
- 修正後「ローカルでは `.env` に `API_URL` を設定してね。CI ではジョブの環境変数に設定するよ。」
## ドキュメント
既存の README が「です・ます」調で、同じ処理を「リクエスト」と呼んでいる場面。
- 修正前「要求の送信前に、設定値の確認を行う。」
- 修正後「リクエストを送る前に、設定値を確認します。」
文末と用語は周囲の文章に合わせる。「確認を行う」は「確認する」で動作が伝わる。
技術文書では、状態の変化を読み手が確かめられるように書く。たとえば、キャッシュを消す操作が完了したら、次の読み込みでサーバーからデータを取得する仕様の場合。
- 修正前「キャッシュの削除で、読み込みがリセットされます。」
- 修正後「キャッシュを削除すると、次の読み込み時にブラウザーがサーバーからデータを取得します。」
## コードコメント
同じ ID に対する重複処理を防ぐため、リクエストを送る前に処理済みの ID を確認する場面。
- 修正前「処理済みの ID を確認する。」
- 修正後「リトライ時に同じ ID のリクエストを二重送信しないため、処理済みか確認する。」
処理の理由がコードだけでは読み取りづらい場合は、どの条件で何を防ぐのかを書く。
複数の処理が続く場合は、担当が変わる場所で名前を出す。
- 修正前「保存に成功すると通知して一覧を更新する。」
- 修正後「保存に成功すると、サーバーが完了イベントを送る。イベントを受け取ったクライアントが一覧を再取得する。」
## 結論と要約
手元で障害を再現しようとしたが再現せず、修正は入れていない場面。
- 修正前「不具合は解消しました。」
- 修正後「手元の環境では不具合を再現できませんでした。」
要約では、確認した環境と結果が伝わるように書く。
PR の説明には、あとから確認を引き継げる情報を残す。
- 修正前「まだ自分では確認できていません。」
- 修正後「未確認の項目は、キャッシュ削除後のオフライン表示です。ネットワークを切断して再読み込みし、案内が表示されることを確認してください。」
## コミットメッセージ
組織で日本語のコミットメッセージを使っていて、入力値が空のときに保存できないよう修正した場面。
- 修正前「保存の挙動をいい感じに修正」
- 修正後「fix: 名前が空のときにプロフィールを保存できないようにする」
接頭辞はプロジェクトの規約に合わせる。本文には、変更した操作や条件を書く。
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack." | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |