/
AboutNotation.txt
120 lines (110 loc) · 4.03 KB
/
AboutNotation.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
■全体方針
・「ここでは~を説明します」など、自分の動作を説明するだけの記述はカットする
⇒それがわかるように見出しや解説を工夫する
・見出しを名詞や動名詞にすることは控え、以下を多めにする
「~する(には)」
「~すると~なる(メリット)」
「~とは」
「~のはなぜか」
「問題は~」
・「~とは~というものです」など、相手に覚えることを強いる文章から始めないようにする
⇒まずは、これから解説しようとしていることを理解する意味や状況(理解しておかないと、どんなことが、どう問題になるか)を伝えて興味をもってもらうようにする
■記号
句読点 、。
英数字 半角
記号類(※()、/、・、!、?、%、&、“”、+、-、×、÷など) 全角
区切り(「~をする/しない」など) /(・/,/、は避ける)
音引き(-。サーバー、ディレクトリー、ドライバー、パラメーター、フォルダー、プロパティー、ペアー、マネージャーなど) 残さない(例外:ユーザー)
■レイアウト
・段落頭は全角1字分スペースを入れて始める
・段落間は空行は入れない
・URLや「このように記述します」というサンプルなどは、「以下のとおりです」などとして抽出+前後1行空けて見やすくする
・方法、ケースなどが複数とおりある場合は、箇条書きにして見通しをよくする
・手順は1ステップずつ段落をおこす
・読みやすさを重視して改行する
・表や箇条書きの末尾の句点はトル
・順番は ⇒ などの記号を利用して流れをわかりやすく表現する
■見出しの階層など
・階層は章-節-項-小見出しの4段階程度にとどめる
・章トビラにリード文は入れない
・章トビラの直後には節見出しがくる
・節見出しと項見出しの間に文章が入ることは許容する
■表記(全体的に、漢字の比率をおさえるように)
※画面キャプチャなどの表記は修正しないよう注意
当たり前 あたりまえ
予め あらかじめ
改める あらためる
いい よい
幾つ いくつ
色々 いろいろ
嬉しい うれしい
大まか おおまか
お奨め、お薦め おすすめ
恐らく おそらく
主な おもな
且つ かつ
簡単 かんたん
下さい ください
詳し くわし
事 こと
毎 ごと
早速 さっそく
様々 さまざま
更なる さらなる
更に さらに
仕組み しくみ
従って したがって
したがう 従う
過ぎる すぎる
づつ ずつ
既に すでに
素晴らしい すばらしい
全て すべて
すむ 済む
是非 ぜひ
揃える そろえる
確かに たしかに
例えば たとえば
誰 だれ
誰 だれ
付 付き
繋がる つながる
出来る できる
通り とおり(「N通り」の場合は漢字のまま)
とき 時
共に ともに
無い ない
何故 なぜ
ばあい 場合
一言 ひとこと
踏まえ ふまえ
間違 まちが
全く まったく
面倒 めんどう
貰う もらう
奴等 やつら
緩やか ゆるやか
様な ような
良く よく
分かる わかる
つど 都度
~という事 ~ということ
~という物 ~というもの
~箇所/~個所/~ヶ所 ~ヵ所
~する方がよい ~するほうがよい
■技術用語
インターフェイス インターフェース
ウィルス ウイルス
ハンドシェーク ハンドシェイク
マネジャー マネージャー
■言い回しの簡素化
~を行う ~する ※「見直しを行う ⇒ 見直す」など
~することができる ~できる
~することが可能 ~できる
~という なるべくカット
~に対して に
~のほう へ
~など なるべくカット
~によって で
~ということ なるべくカット
~について なるべくカット