japanese-technical-writing
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
Chinese日本語テクニカルライティングガイド
Japanese Technical Writing Guide
日本語で分かりやすいドキュメントを書くためのルール集。
以下のルールに従い、明確・簡潔・正確な日本語文章を生成する。
A set of rules for writing easy-to-understand documents in Japanese. Follow the rules below to generate clear, concise, and accurate Japanese text.
出力前の必須チェック
Mandatory Checks Before Output
文章を出力する前に、以下の3点を必ず確認する。これらは最も頻繁に違反されるルールである。
Before outputting any text, be sure to check the following three points. These are the most frequently violated rules.
1. 「〜を行う」を使っていないか
1. Check for the use of "〜を行う" (do ~)
「〜を行う」は冗長表現の代表例であり、ほぼ全ての場合に短縮できる。出力に含まれていたら必ず書き換える。
| 冗長 | 簡潔 |
|---|---|
| 判定を行う | 判定する |
| 処理を行う | 処理する |
| 検証を行う | 検証する |
| ソートを行う | ソートする |
| 制御を行う | 制御する |
| 付与を行う | 付与する |
"〜を行う" is a representative example of redundant expression and can be shortened in almost all cases. If it appears in the output, rewrite it without fail.
| Redundant | Concise |
|---|---|
| Perform a judgment | Judge |
| Perform processing | Process |
| Perform verification | Verify |
| Perform sorting | Sort |
| Perform control | Control |
| Perform assignment | Assign |
2. 同じ文末が3回以上連続していないか
2. Avoid repeating the same sentence ending three or more times in a row
特にだである調で「〜する」「〜である」が連続しやすい。以下の代替表現を活用して変化をつける。
だである調の文末バリエーション:
| パターン | 例 |
|---|---|
| 〜する | ソート順を決定する |
| 〜である | この値は定数である |
| 〜となる | 配信対象となる |
| 〜になる | 無効になる |
| 〜を返す | true を返す |
| 〜に該当する | この条件に該当する |
| 〜が必要である | 検証が必要である |
| 〜に限る | 公開期間中に限る |
| 〜を意味する | リスト型号外を意味する |
| 体言止め | 以下のとおり |
番号付き手順リストでの注意:
手順リストは「〜する」で終わりがちだが、3回以上連続させてはならない。以下のように書き換える。
悪い例:
- 対象のIDを取得する
- ユーザーの所属を確認する
- インプレッションを付与する
良い例:
- 対象のIDを取得する
- ユーザーの所属を確認する
- 未付与のContentUserGroupにインプレッションを記録する（「記録する」「返す」「設定する」など別の動詞に変える）
別の良い例（体言止めを混ぜる）:
- 対象IDの取得
- ユーザー所属の確認
- インプレッションの付与
Especially in the "だである" (formal) style, endings like "〜する" (do) and "〜である" (is) tend to repeat. Use the alternative expressions below to add variety.
Sentence ending variations for the "だである" style:
| Pattern | Example |
|---|---|
| 〜する (do) | Determine the sort order |
| 〜である (is) | This value is a constant |
| 〜となる (become) | Become a distribution target |
| 〜になる (become) | Become invalid |
| 〜を返す (return) | Return true |
| 〜に該当する (correspond to) | Correspond to this condition |
| 〜が必要である (be necessary) | Verification is necessary |
| 〜に限る (be limited to) | Be limited to the public period |
| 〜を意味する (mean) | Mean outside the list model number |
| Noun ending | As follows |
Notes for numbered procedure lists:
Procedure lists tend to end with "〜する", but they should not be repeated three or more times. Rewrite them as follows.
Bad example:
- Obtain the target ID
- Confirm the user's affiliation
- Assign an impression
Good example:
- Obtain the target ID
- Confirm the user's affiliation
- Record the impression in the unassigned ContentUserGroup (use a different verb like "record", "return", "set", etc.)
Another good example (mixing noun endings):
- Obtain the target ID
- Confirm the user's affiliation
- Assign an impression
3. 形式名詞が漢字になっていないか
3. Check for kanji used in formal nouns incorrectly
- 〜する事 → 〜すること
- 〜の為 → 〜のため
- 〜する物 → 〜するもの
- その時 → そのとき
- 〜して下さい → 〜してください
- 〜する事 → 〜すること (do ~)
- 〜の為 → 〜のため (for ~)
- 〜する物 → 〜するもの (thing that does ~)
- その時 → そのとき (that time)
- 〜して下さい → 〜してください (please do ~)
基本原則
Basic Principles
- 簡潔に書く: 無駄な表現を省き、短く明確に伝える
- 能動態を使う: 原則として能動態で書き、文章に力強さと明確さを持たせる
- 文体を統一する: ですます調/である調を混ぜない。文末表現の繰り返しを避ける
- 主語と述語を近くに置く: 主語と述語の間に余計な語句を入れすぎない
- やさしい言葉を使う: 難しい漢字、専門用語、カタカナ用語を避ける
- Write concisely: Eliminate unnecessary expressions and convey information briefly and clearly.
- Use active voice: In principle, use active voice to give sentences strength and clarity.
- Unify the writing style: Do not mix "ですます" (polite) and "だである" (formal) styles. Avoid repeating sentence endings.
- Place subjects and predicates close together: Do not insert unnecessary words between the subject and predicate.
- Use simple language: Avoid difficult kanji, technical terms, and katakana terms.
1. 簡潔さ
1. Conciseness
冗漫な表現を避け、できるだけ短く表現する。
Avoid verbose expressions and keep them as short as possible.
同語反復を避ける
Avoid repeating the same word
同じ意味の言葉を繰り返さない。
- 20秒の期間 → 20秒
- あらかじめ予測する → 予測する
- 未だ未解決 → 未解決
Do not repeat words with the same meaning.
- 20 seconds period → 20 seconds
- predict in advance → predict
- still unresolved → unresolved
動詞の名詞化を避ける
Avoid nominalizing verbs
動詞を無理に名詞に変えない。
- 行動をする → 行う
- 可能です → できます
- 集客支援を行う → 集客を支援する
- 充填する → うめる
- 陳述する → のべる
Do not force verbs into nouns.
- take action → act
- it is possible → can
- perform customer acquisition support → support customer acquisition
- fill → fill
- state → state
不要な語句を省く
Omit unnecessary words
なくても意味が通じる語句は省く。
- 初回のケースに関しましては → 初回のケースは
- 「〜について」「〜という」は多くの場合削除できる
Omit words that do not affect the meaning.
- Regarding the first case → The first case is
- "〜について" (about) and "〜という" (called) can be deleted in most cases.
曖昧な表現を避ける
Avoid ambiguous expressions
文末や文章中の曖昧さを排除し、具体的に書く。
- タイトルの修正が効果的だと思われます → タイトルの修正が効果的です
- 少し長い → 5cmほど長い
Eliminate ambiguity at the end of sentences or in the text, and write specifically.
- It seems that correcting the title is effective → Correcting the title is effective
- a bit long → about 5cm longer
不要な強調語を削除する
Remove unnecessary emphasis words
- 極めてユニークな → ユニークな
- 非常に重要な → 重要な
- extremely unique → unique
- very important → important
もったいぶった言い回しを避ける
Avoid pretentious phrasing
- 「次のことが言えるといえるだろう」→ 削除
- 「どうなのでしょうか。それでは詳しく見てみましょう」→ 削除
- "It can be said that the following is true" → Delete
- "What do you think? Let's take a closer look" → Delete
2. 文体
2. Writing Style
文末表現を統一する
Unify sentence endings
「ですます調（敬体）」か「だである調（常態）」のいずれかに統一する。同じ文章中で混ぜない。
Unify either the "ですます" (polite) style or the "だである" (formal) style. Do not mix them in the same text.
文末表現の繰り返しを避ける
Avoid repeating sentence endings
同じ文末が3回以上続かないようにする。バリエーションを使う。
- 〜です / 〜ます / 〜でした / 〜ました
- 〜ません / 〜でしょう
- 〜ください / 〜してください
- 体言止め（名詞で終える）
Do not repeat the same sentence ending three or more times in a row. Use variations.
- 〜です / 〜ます / 〜でした / 〜ました (polite endings)
- 〜ません / 〜でしょう (negative/polite conjecture)
- 〜ください / 〜してください (please do ~)
- Noun ending
話し言葉を書き言葉にする
Convert spoken language to written language
| 話し言葉 | 書き言葉 |
|---|---|
| いっぱい | 多い |
| ちょっと | 少し |
| とても | 非常に |
| そういう | そのような |
| もっと | さらに |
| やっぱり | やはり |
| けど | が |
| ですから | そのため |
| たぶん | おそらく |
| 一番 | 最も |
| いつも | 常に |
| ちゃんと | きちんと |
| Spoken Language | Written Language |
|---|---|
| a lot | many |
| a little | a little |
| very | very |
| that kind of | such |
| more | further |
| after all | after all |
| but | but |
| so | therefore |
| probably | probably |
| best | most |
| always | always |
| properly | properly |
文語体を口語体にする
Convert literary style to colloquial style
| 文語体 | 口語体 |
|---|---|
| のみならず | だけでなく |
| においては | では |
| すべく | するため |
| できぬ | できない |
| Literary Style | Colloquial Style |
|---|---|
| not only | not only |
| in | in |
| in order to | in order to |
| cannot | cannot |
3. 文構造
3. Sentence Structure
主語と述語を近くに置く
Place subjects and predicates close together
主語と述語の距離が遠いと読みにくくなる。長い場合は文を分割する。
悪い例:
弊社は、ユーザー様がご満足される視聴者向けマーケティング施策を、弊社サービス会員や関係者に、弊社の商品の根強いファンになっていただくことを期待し展開しております。
良い例:
弊社は、さまざまな視聴者向けマーケティング施策を展開しております。その目的は、弊社サービス会員や関係者にご満足いただき、弊社商品の根強いファンになっていただくことです。
If the distance between the subject and predicate is too large, the text becomes hard to read. Split the sentence if it is too long.
Bad example:
Our company implements various marketing measures for viewers, with the expectation that our service members and related parties will be satisfied and become loyal fans of our products.
Good example:
Our company implements various marketing measures for viewers. The purpose is to satisfy our service members and related parties, and to have them become loyal fans of our products.
能動態を原則にする
Use active voice as a principle
能動態は明確で説得力がある。受動態は以下の場合にだけ使う。
- 動作主が重要でない場合（例: その行為は犯罪と考えられる）
- 動作を受ける対象を強調したい場合
- 文体をあえて弱めたい場合
- 能動態が連続して単調になる場合
Active voice is clear and persuasive. Use passive voice only in the following cases:
- When the actor is not important (e.g., That act is considered a crime)
- When you want to emphasize the object receiving the action
- When you want to intentionally soften the writing style
- When active voice becomes monotonous due to repetition
修飾語を被修飾語の近くに置く
Place modifiers close to the words they modify
- 素早い花の先に止まったテントウ虫 → 花の先に止まった素早いテントウ虫
- A fast ladybug that stopped on the tip of a flower → A ladybug that stopped on the tip of a flower, which is fast
主語を統一する
Unify subjects
連続する文では、文脈上の主語と文法上の主語を一致させる。
In consecutive sentences, match the contextual subject with the grammatical subject.
4. 語の選び方
4. Word Selection
やさしい言葉を使う
Use simple language
難しい漢語や一般化していないカタカナ用語を避ける。
- 措置 → 処置・取扱い
- コンセンサス → 合意
- フィジビリ → 実験
- RFP → 提案依頼書（初出時に説明を添える）
Avoid difficult Chinese-style words and non-generalized katakana terms.
- measures → treatment/handling
- consensus → agreement
- feasibility → experiment
- RFP → Proposal Request Form (add an explanation when first mentioned)
不要な省略を避ける
Avoid unnecessary abbreviations
- MTG → ミーティング
- MGR → マネージャー
ただし、チーム内で定着した略語はそのまま使ってよい。
- MTG → meeting
- MGR → manager
However, abbreviations established within the team can be used as is.
独自の複合名詞を避ける
Avoid original compound nouns
- 時間短縮料理術 → 時間が短縮できる料理術
- time-saving cooking technique → cooking technique that saves time
代名詞・指示語の曖昧さを避ける
Avoid ambiguity in pronouns and demonstratives
「それ」「これ」などの指示語が何を指すか曖昧な場合は、名詞を再び記載するか、「そのカード」のように名詞を補足する。
If demonstratives like "それ" (it) or "これ" (this) are ambiguous, rephrase to include the noun or supplement it like "そのカード" (that card).
5. 漢字・ひらがなの使い分け
5. Distinguishing Between Kanji and Hiragana
ひらがなで書く語（ひらく）
Words to write in hiragana
本来の意味を失った語や補助的な語はひらがなで書く。
形式名詞:
- 見た所 → 見たところ（場所の意味でなければひらく）
- その時 → そのとき（時間の意味でなければひらく）
- 〜する事 → 〜すること
- 〜する為 → 〜するため
- 〜する物 → 〜するもの（物体の意味でなければひらく）
補助動詞:
- 調べて見る → 調べてみる（視覚の意味でなければひらく）
- 行って来る → 行ってくる
- 行きたく無い → 行きたくない
- 〜して欲しい → 〜してほしい
- 〜して下さい → 〜してください
接続詞:
- ただし、または、および、かつ、また、さらに
連体詞・代名詞:
- この、その、わが、あらゆる
- あなた、われわれ、ここ、そこ
Write words that have lost their original meaning or auxiliary words in hiragana.
Formal nouns:
- 見た所 → 見たところ (as far as I can see - write in hiragana if not referring to a place)
- その時 → そのとき (that moment - write in hiragana if not referring to time)
- 〜する事 → 〜すること (do ~)
- 〜する為 → 〜するため (for ~)
- 〜する物 → 〜するもの (thing that does ~ - write in hiragana if not referring to an object)
Auxiliary verbs:
- 調べて見る → 調べてみる (try looking into - write in hiragana if not referring to visual action)
- 行って来る → 行ってくる (go and come back)
- 行きたく無い → 行きたくない (don't want to go)
- 〜して欲しい → 〜してほしい (want someone to do ~)
- 〜して下さい → 〜してください (please do ~)
Conjunctions:
- however, or, and, also, furthermore
Adjectival nouns/pronouns:
- this, that, our, all
- you, we, here, there
漢字で書く語（とじる）
Words to write in kanji
固有名詞、専門用語はそのまま漢字で書く。常用漢字の範囲で使用する。
Proper nouns and technical terms are written in kanji as is. Use within the range of common kanji.
6. 約物（記号）の基本ルール
6. Basic Rules for Punctuation
句読点
Periods and commas
- 句点（。）は文の終わりに打つ
- 読点（、）は誤読を避けるために打つ（打ちすぎない）
- Use a period (。) at the end of a sentence.
- Use a comma (、) to avoid misreading (do not overuse).
三点リーダー
Ellipsis
- ・・・ → ……（三点リーダーを2つ並べる）
- ・・・ → …… (Use two sets of three dots)
疑問符・感嘆符
Question marks and exclamation points
- 疑問符（？）の後に全角スペースを入れる
- 感嘆符（！）は公式文章では原則使用しない
- Insert a full-width space after a question mark (？).
- Do not use exclamation points (!) in official documents in principle.
数値
Numbers
- 横書きでは半角アラビア数字を使う
- 訓読み（一つ、二つ）、順序（一番目）、副詞（第一に）は漢字
- Use half-width Arabic numerals for horizontal writing.
- Use kanji for kunyomi readings (one, two), order (first), and adverbs (firstly).
丸括弧
Parentheses
- 全角括弧を基本とする
- 使いすぎに注意し、本文に入れ込めないか検討する
- Use full-width parentheses as a base.
- Be careful not to overuse; consider integrating the content into the main text.
波ダッシュ（〜）
Wave dash (〜)
- 範囲を表す場合に使う（例: 1〜3日）
- 数値と数値、名詞と名詞をつなぐ（「当日〜3日」は不可、「1〜3日」が正しい）
- Use to indicate a range (e.g., 1〜3 days).
- Connect numbers to numbers or nouns to nouns (「当日〜3日」 is invalid; 「1〜3日」 is correct).
7. その他の重要ルール
7. Other Important Rules
並列表現
Parallel Expressions
- 同じ文法構成を繰り返す
- 「たり」は2つ目を省略しない
- 楽しんだり、没頭するのがよい → 楽しんだり、没頭したりするのがよい
- 箇条書きでは文法的に同じ構造のものを並べる
- Repeat the same grammatical structure.
- Do not omit the second "たり" in a list:
- It's good to have fun and immerse yourself → It's good to have fun and immerse yourself
- In bullet points, list items with the same grammatical structure.
助詞の使い方
Particle Usage
- 起点の「より」は「から」に言い換える
- 東京より参りました → 東京から参りました
- 推量の「う」は「だろう」に言い換える
- 言えよう → 言えるだろう
- 並列の「と」は比較対象が曖昧になる場合に省略しない
- Replace the starting particle "より" with "から":
- I came from Tokyo → I came from Tokyo
- Replace the conjecture particle "う" with "だろう":
- I can say → I can say
- Do not omit the parallel particle "と" if the comparison target is ambiguous.
副詞の係り受け
Adverb and Sentence Ending Pairs
副詞と文末のペアを正しく使う。
| 副詞 | 文末 |
|---|---|
| なぜなら | 〜からだ |
| もし | 〜たら |
| 決して | 〜ない |
| おそらく | 〜だろう |
| たとえ | 〜ても |
| ぜひ | 〜ほしい / 〜ください |
| まるで | 〜ようだ |
Use the correct pairs of adverbs and sentence endings.
| Adverb | Sentence Ending |
|---|---|
| because | because |
| if | if |
| never | not |
| probably | probably |
| even if | even if |
| please | want / please do |
| as if | as if |
比較構文
Comparative Sentences
- 何と何を比較しているか明確にする
- 比較の対象を省略しない
- Clearly state what is being compared.
- Do not omit the comparison target.
詳細リファレンス
Detailed References
より詳しいルールや例文が必要な場合は ディレクトリを参照する。
docs/| ファイル | 内容 |
|---|---|
| nouns.md | 名詞の使い方の詳細と例 |
| pronouns.md | 代名詞・指示語の曖昧さ回避 |
| adjectives.md | 形容詞・形容動詞の修飾語配置 |
| adverbs.md | 副詞の係り受け（呼応表現）全パターン |
| particles.md | 助詞・助動詞の使い分け |
| conciseness.md | 簡潔に書く方法の詳細 |
| subject-predicate.md | 主語と述語の関係 |
| active-passive-voice.md | 能動態・受動態の使い分け |
| parallel-structure.md | 並列表現の使い方 |
| comparison.md | 比較構文の書き方 |
| emphasis-marks.md | 強調記号の使い方 |
| writing-style.md | 文体のルール |
| punctuation.md | 約物の12のルール |
| kanji-hiragana.md | 漢字・ひらがなの使い分け |
| citation.md | 引用の書き方 |
For more detailed rules and examples, refer to the directory.
docs/| File | Content |
|---|---|
| nouns.md | Details and examples of noun usage |
| pronouns.md | Avoiding ambiguity in pronouns and demonstratives |
| adjectives.md | Placement of modifiers for adjectives and adjectival verbs |
| adverbs.md | All patterns of adverb and sentence ending pairs |
| particles.md | Distinguishing between particles and auxiliary verbs |
| conciseness.md | Details on how to write concisely |
| subject-predicate.md | Relationship between subjects and predicates |
| active-passive-voice.md | Distinguishing between active and passive voice |
| parallel-structure.md | Usage of parallel expressions |
| comparison.md | How to write comparative sentences |
| emphasis-marks.md | Usage of emphasis marks |
| writing-style.md | Rules for writing style |
| punctuation.md | 12 rules for punctuation |
| kanji-hiragana.md | Distinguishing between kanji and hiragana |
| citation.md | How to write citations |