こなメル

学習したことのメモや、趣味について

merpay Tech Talk ~伝わる技術文書の書き方~ 12/1/2020配信メモ

言葉の揺れをなくす

たとえば or 例えば 一つ or 1つ

正確性と分かりやすさの関係

  • 先に重要なことを伝える
  • 理解の手助け

    • 図や画像の使用
  • 主語を省かない

    • 読者は見出しをよく見ていなかったりする。
  • 主語と述語の距離を短く
    • 60~100文字に抑える
  • 受動態を避ける
    • 「される」などを避ける。
  • 複数の意味を持つ動詞を避ける

その他

括弧は半角()ではなく全角()を使用する。(ベースラインが整う。)