入門テクニカルライティング - 浜村拓夫（・∀・）作品集

最近、プログラミングの説明などを分かりやすくしたいと思いました。

テクニカルライティングの参考書を読んで、文章の書き方を改善してみたいと思います。

プログラミングの本を多数書いている高橋麻奈さんの「入門テクニカルライティング」という本が参考になりました。

入門テクニカルライティング

作者:高橋麻奈
発売日: 2005/06/01
メディア: 単行本

目次
著者紹介
出版社情報
書評

　どんな「技術文書」があるのか
　もう１つ、「技術文書」を取り上げる
　「技術文書」をイメージする
　知識を伝える「解説書」
　経験を伝える「報告書」
　主張をする「提案書」
　「技術文書」のまとめ方
　練習問題

3.　事物・概念を書く

　「モノ」を解説する
　短文を心がける
　定義する
　なぜ定義が必要か？
　事物をテーマに解説する
　具体例を展開する
　構成要素を展開する
　事物の関係を意識する
　さまざまな事物を解説する
　「モノ」を解説するということ
　練習問題

4.　現象・法則を書く

　事実を述べる
　順序づけて書く
　事実を展開する
　状況を分ける
　理由を述べる
　要約をまとめる
　さまざまな事実を述べる
　事実を述べるということは
　練習問題

5.　方法・手順を書く

　方法・手順を解説する
　目標を掲げる
　手順の流れを作る
　１つ１つの動作を書く
　さまざまな方法・手順を解説する
　人間の動作を書くということ
　練習問題

6.　推測・予測を書く

　「考え」を述べる
　推測の述べ方
　複数の仮説をたてる場合
　原因を推測する
　因果関係を追う
　データをもって論証する
　論証で述べる事実とは
　将来の現象を予測する
　事実を推測・予測するということ
　練習問題

7.　評価・意見を書く

　技術を評価する
　評価・意見を述べるには
　さまざまな評価・意見がある
　利点を述べる
　利点・欠点をあげる
　技術を比較する
　技術を提案する
　自分の意見を述べるということは
　練習問題

8.　技術文書を書く

　テーマを組み立てる
　文書の種類を考える
　文書を構成する
　解説書のアウトラインを考える
　報告書のアウトラインを考える
　提案書のアウトラインを考える
　具体的なタイトルをつける
　アウトラインは道標となる
　練習問題

9.　さまざまな技術文書

　技術文書を書く
　解説書を書く
　取扱説明書を書く
　報告書を書く
　提案型の文書をまとめる
　文書を作成する
　練習問題

10.　自分の技術をまとめる

　技術をまとめる
　丁寧に述べる
　要約を述べる
　類似点・相違点を述べる
　重要度に注意する
　簡潔にまとめる
　箇条書きにする
　技術をまとめるということ
　練習問題

11.　読者の技術を意識する

　読者を知る
　読者と対話する
　知識を分析する
　理由を伝える
　具体例をあげる
　比喩を使う
　読者を意識した文書
　練習問題

12.　表・グラフを使う

　文章をこえた表現
　表を整理する
　グラフに測定値を記入する
　本文中でグラフを使う
　グラフを使い分ける
　誤った印象を与えないように
　表とグラフの力
　練習問題

13.　写真・イラストを使う

　強力な表現方法
　写真を使う
　イラストを使う
　概念を表す
　構造を表す
　息抜きのイラストを入れる
　イラストか？　文章か？
　練習問題

14.　文書を推敲する

　紙に印刷して読む
　アウトラインを確認する
　見出しを確認する
　短文にする
　「～が」に気をつける
　修飾部に気をつける
　余分な表現を削除する
　漢字・ひらがなを調節する
　練習問題

15.　文書を発表する

　技術文書を発表する
　発表の場を探す
　プリンタで印刷して配布する
　雑誌・書籍で発表する
　Webで公開する
　文献を整理する
　基礎をおさえて実践へ

参考文献

索引

著者紹介

www.google.com

著者略歴

高橋麻奈　たかはしまな

1971年　東京都に生まれる

1995年　東京大学経済学部卒業

主著　「やさしいJava」「やさしいC」（ソフトバンククリエイティブ）

　　　「やさしく学ぶ基本情報技術者」（翔泳社）

　　　「常識として知っておきたいプログラムの仕組み」（PHP研究所）

　　　「心くばりの文章術」（文藝春秋）