Technical writing
会社で勉強した内容をアップ
techenical writing
早く書く
その後に質
主語と述語を意識する
文章の前後関係をみる
主語と述語の距離
文章のブロックは少ないほどわかりやすい
文を短くする
「し」でつなぐと長くなる
「。」で分ける
どうしても列挙する情報が多い場合は箇条書きにする
手順と結果をわける
語順に気を配る
誤解されないような語順
誤解を招くような書き方に気づく
前提知識が必要な場合は注意
天気予報
時々 or 一時 => 一時の方が雨が多い
1 日の 1/4 以下だったら「一時」を使う
これは気象庁が決めたルール
開発時に使っていた言葉をユーザにそのまま提供してないだろうか?
Tips
記号は全角
早く書くのに邪魔な要素を入れない
複合名詞や構造を避ける
「の」などの助詞を入れる
文章は短かったり、感じだから読みやすいわけではない
漢字にするのかしないのか
漢字を開く
ひらがなで表現して、複数の意味が発生するなら漢字を使う
同じものは同じ名前で
表記揺れに気をつける
接続しなど、よく使う言い回しは限定する
ex. だから、それで、そのため、したがって
敬語はいらない
していただきます => してください
冗長を嫌う
おなかが腹痛で痛い => お腹が痛い
安易に強調しない
「する必要があります」などはいらない
自信をもって書く
「可能性があります」など
二重否定を避ける
「○○ してないと、△△ できません」など