伝わる文書を書く

概要

  • 対象:伝わる文書を書きたい人
  • なぜやるか
  • なぜ自分がやるか
  • 効率的・効果的にテキストコミュニケーションをする
  • 読み手にとって良い文書を書く
  • どのくらい良い文書を書くよう心がけるべきか
  • 今日話すこと
    • 伝わる文書を書くための原則と、重要なテクニックを紹介する
    • 実例をいくつか紹介する

伝わる文書を書くためにやるべきこと

  • より良い文書を書こうという意思を持つ
  • 基準を学ぶ
    • 目的や基準を明確にしないと、改善できない
    • 良い文書とは何か:正しく効果的に伝わる文書
    • 情報価値 - 生産コスト を高めたい
    • 宣伝: と品評会で、良い文書が生み出され届く仕組みを作りたい
  • 書く技術を身につける
    • 文書の目的を明確にする
    • 短く書く
    • 構造的に書く
    • 正しく・誤解されないように書く
    • 表現を磨く
  • 文書を改善するための技術を身につける
    • 一般的なプロセス:アイデア、情報収集、放棄、論理化、文書化、校閲、校正
    • 考える
    • 見直しをする
    • レビューを受ける
  • 継続的に学ぶ
    • 言語を学ぶ
    • 書く技術をもっと学ぶ
    • 文書を書く
    • フィードバックを受ける

参考文献

  • https://developers.google.com/tech-writing/overview
    • Google が開発者向けに公開しているテクニカルライティングに関するドキュメント
    • 要点がよくまとまっているが英語で書いてあり、また英語に特化した内容も含まれる
  • 理科系の作文技術
    • より本格的に勉強したい人向けの書籍
    • あっさり系(著者のバックグラウンドは研究者)
  • 日本語の作文技術
    • より本格的に勉強したい人向けの書籍
    • こってり系(著者のバックグラウンドは新聞社)
      • 本人の思想が強く、実用性から離れてたり余分な一言が入ったりする点がある
        • 例:日本語の文書の数値3桁区切りにするのは植民地的な思想なので4桁にせよとか書いてあるが、3桁が主流なので普通に読みにくそうだなと思った

宣伝:文芸部

事例1:野良文書

usui さんからスタンプもらったので見てみたけど、usui さん普通に訓練を受けている人なので、姑的なホコリしか拾えなかった
    • かなりいい
    • 構造が明確
    • 誤字脱字がほぼない
    • Slack のラフなテキストだし、今の完成度で全く問題ないが、今後のための些末な指摘
      • 機能の使い方が不正確
      • notion→Notion(他の箇所では大文字小文字を意図的にかき分けているので、たぶん単純に知らないだけ)
    • 箇条書き
    • 具体
    • 各マネージャーに評価に対して違和感覚えた部分を確認
      • 評価に対して違和感覚えた部分を各マネージャーに確認
      • 評価に違和感あれば各マネージャーに確認

事例2:テックブログのレビュー

事例3:自分がプロにレビューしてもらったもの