ドキュメントを書くのが苦手だから「文章力を上げたい」と考えるエンジニアは少なくないが、ドキュメント力は文章力とイコールではない。実は、わかりやすいドキュメントを書きたいのなら、そもそも「文章を書かない」ほうがよいのである。エンジニアが書く仕様書や説明書は、小説や報道記事とは違う。そこに求められる最適な表現形式やノウハウも違ってきて当たり前なのだ。 今回は、「箇条書き」をよりスマートにした「ラベル付きステートメント構造」を使う習慣を身につけよう。ちょっとした工夫ではあるが、これだけで「短時間で正確に読み取りやすい技術ドキュメント」を書くことができる。しかも、わけのわからない「文章力」というスキルは必要ないし、にもかかわらず文章の読解力も上がってしまうという一石二鳥、三鳥の方法なのである。
※印刷用ページ表示機能はメンバーのみが利用可能です（登録無料）。
この記事は参考になりましたか？
- 例題でわかる！ 伝わるドキュメントの書き方トレーニング連載記事一覧
-
- 意識のスコープを縮小せよ
- 文章を書くな、ラベル付きステートメント構造を使え
- ドキュメントに「夜間バッチ」と書いてはいけない
- この記事の著者
-
開米 瑞浩（カイマイ ミズヒロ）
東京大学理科一類中退。ＩＴ技術者の業務経験を通して「読み解き、考え、説明する」スキルの再教育の必要性を認識し、2003年からその著述・教育業務を開始。小説家を目指したほどの文章力にもかかわらず図解を多用し「文章は図解の添え物」との主張が持論。図解力、思考力、プレゼンテーション等の講師として民間企業・官公庁での研修実...
※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です
この記事は参考になりましたか？
この記事をシェア
