ソフトウェアの開発において、ドキュメントの役割は計り知れません。意思決定の過程と結果を記録し、チームや外部と情報共有する際にも不可欠です。ですが、Excelのセルを結合して使用するExcel方眼紙はいまだにはびこり、めんどくささから脱しきれてはいません。そこで提案したいツールが、Wordです。CodeZineを運営する翔泳社では、Wordでメンテナンス性の高いドキュメントを作るための『エンジニアのためのWord再入門講座 新版』を6月10日(水)に発売しました。
『エンジニアのためのWord再入門講座 新版 美しくメンテナンス性の高い開発ドキュメントの作り方』は、2008年に発売した初版を12年ぶりに改訂し、2020年3月時点のMicrosoft 365(Word 2019相当)に対応したWordの解説本です。
ソフトウェア開発の現場では各種のドキュメントが欠かせませんが、今もExcelやPowerPointが作成ツールの筆頭になっており、「ドキュメントを作るのはめんどくさい」という呪縛に囚われているケースが少なくありません。しかし、実はWordを使えば必要な情報を伝えることに注力でき、メンテナンス性の高いドキュメントを作ることができるのです。
著者の佐藤竜一さんは、初版を執筆した動機がExcel方眼紙に出会った衝撃にあったと語ります。2008年当時に比べてExcel方眼紙は「消極的賛成」のツールになったと感じているそうですが、まだWordが積極的に使われている状況ではないとのこと。
佐藤さんは本書で、ポイントを押さえればWordがいかにドキュメント作成と保守に適しているかを解説。初期設定はもちろん、なるべくデザインについて考えずに体裁を整えられるTIPSも豊富で、図表の使い方や作業効率の改善についてもアドバイスが。
Wordは意図せぬ謎の動作のせいで利用を避けがちな方もいるかもしれません。ですが、それも本書を読めば解決。必要なドキュメントを最低限の労力で作るために、ぜひ本書を参考にしてみてください。
目次
第1章 ドキュメント作成の意味とは?
1.1 なぜドキュメントを作成するのか
1.2 よいドキュメントの条件とは?
1.3 なぜWordなのか
1.4 ワードプロセッサ再考
第2章 これだけはやっておきたいWordの初期設定
2.1 初期設定の勘所
2.2 オートコレクトとオートフォーマット
2.3 スペルチェックと文章校正の使い方
2.4 最大の編集領域を確保する
第3章 スタイルを理解することから始めよう
3.1 Word文書はスタイルを使うことから始まる
3.2 スタイルを定義してみよう
3.3 箇条書きとアウトライン
3.4 スタイルに関するその他の話題
第4章 DRYで行こう!
4.1 Don't Repeat Yourself!
4.2 クイックパーツで文書のメタ情報を埋め込む
4.3 フィールドの利用
4.4 図表番号を使う
4.5 相互参照を使う
第5章 テンプレートを設計する
5.1 ドキュメント形式の設計とは?
5.2 基本的な見栄えの決定
5.3 スタイルの設計
5.4 ドキュメントとしての体裁を整える
5.5 テンプレートを作成する
第6章 図と表の取り扱い
6.1 Wordで図を作成する
6.2 描画オブジェクトの配置方法
6.3 表の作成テクニック
6.4 表の配置にまつわる問題
第7章 Wordでドキュメント作成効率を改善する
7.1 Wordドキュメントを素早く書き上げるために
7.2 外部の情報を差し込む
7.3 ドキュメント全体の俯瞰
この記事は参考になりましたか?
- この記事の著者
-
CodeZine編集部(コードジンヘンシュウブ)
CodeZineは、株式会社翔泳社が運営するソフトウェア開発者向けのWebメディアです。「デベロッパーの成長と課題解決に貢献するメディア」をコンセプトに、現場で役立つ最新情報を日々お届けします。
※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です