ワードで困った自動機能を避けるために
ここでは、ワードの機能を正しく理解すれば実現できるものの、意外と思い通りにならない自動機能について筆者がどのように避けているかを紹介します。
特に自分が問題なく使える機能であっても、他の人が使えるとは限りません。他の方がドキュメントを変更や追記する際には、これまでの体裁に沿って変更することが想定されるので、できるだけ他の方が変更、追記してもドキュメントが壊れない表記方法をとることが望ましいでしょう。
ただし、このような考慮はもちろん、他の人との兼ね合いであることからも、必ず採用しているわけではないので、場合に応じて使い分けてください。
図の説明についての配置調整
ドキュメント内に図を挿入し、その図について説明を記載したい場合があります。この場合、図とテキストの折り返し機能を使うと思いもよらない回り込みや、図の移動が発生してしまうことがあります。
そのような場合には、図17のように表機能を用いての調整がおすすめです。表機能を用いることで表全体が一つの固まりとして扱われるので、図に関する説明を記載したい場合には、むしろ、折り返し機能よりもドキュメント構造として管理しやすいこともあるかと思います。
自動連番はできるだけ避ける
箇条書きなどに連番をつけて表記したい場合が多々あります。慣れた人にとっては何の問題もない機能に感じます。しかし、なれていない人にとっては、この連番機能のトラブルに遭遇すると解決方法がわからないという場合があります。
従って、図18のように連番機能を使わないリスト形式や、表形式にして記述してしまった方がトラブルになりにくいドキュメントが作成できます。
また、どうしても連番機能を使いたい場合には、1ページ内に納めて記述できるようにして、複数ページにまたがる場合には見出しを使うようにすると良いでしょう。
また、見出しに番号をつけたい場合などもあります。しかし、連番機能を利用する場合には、最も大きな見出し1のみに限定することをおすすめします。見出しで、1.1や2.1.2のような表記はできるだけ使わない方がメンテナンスしやすいドキュメントになります。
メニューがどこにあるかわからない場合
ワードのわかりにくい部分として、画面サイズが小さくなると自動的にメニューが隠れたり、また、WindowsやMac版などでメニュー表示が異なるという問題があります。
デフォルトで表示されていない機能はあまり使うべきではありませんが、どうしても使いたい場合や、見つからない場合には、図19のように検索機能を使うと便利です。
ワードの場合には検索結果から直接、メニュー操作ができるので、メニューを探すのが手間だと感じるならば、検索機能を使ってしまった方がわかりやすいこともあります。
Markdownとの併用
ここまでワードを使ってドキュメントを記述しましょうという趣旨で説明してきました。しかし、やはり、テキストを記述する際にはテキストエディタを使いたい方もいます。また、テキスト形式であれば、プログラムのソースコードと同様に変更管理ができるため、ドキュメントも同様に管理したいというニーズもあります。
筆者も初期のテキストだけは、Markdownのようなテキスト形式で行う場合があります。
そして、ある程度完成したところでワード形式に変更します。その際に利用しているのが、Pandocというツールです。
このツールは、ドキュメント形式の相互変換をする為のツールで、Markdown形式からワードのdocx形式への変換、またはその反対の変換が可能です。ただし、ドキュメントのスタイルのような見た目の再現は完全ではないため、相互変換しながら変更していく使い方は難しいと思います。
筆者は、Markdownでテキスト部分と挿絵部分が完成してから、ワードを使ってスタイルや表記揺れなどの手直しをしていく場合に利用します。
Pandocを使った変換処理
markdownフォーマットからワード形式に変換するには、リスト2のようなコマンドを実行します。詳しい使い方は説明しませんが、より詳しく知りたい方はPandocドキュメント を参照してください。
$pandoc input.md \
--from=markdown \
--to=docx \
--output=output.docx
また、反対にワード形式(docx)からMarkdown形式へ変換する場合には、リスト3のように実行します。
$pandoc input.docx \
--from=docx \
--to=markdown \
--extract-media ./ \
--output=output.md
ただし、出力データはあくまでも、その後、用途に応じて修正する前提と捉えた方がよいと思います。
最後に
二回に分けて技術的なドキュメント作成に筆者がよく利用するワードの使い方について紹介しましたが、ここで紹介していない機能も多々あります。しかし、実際にはほとんど、今回紹介した機能でほとんど間に合っていると思っています。
たまに、[校正]の変更履歴や、セクション区切り機能などを使う場合もありますが、出来るだけ使わないようにしています。その理由として、本校内でも説明していますが、出来るだけ、部分的に修正したい人も変更出来るレベルを意識するとよいでしょう。
体裁が整った情報があると、多くの方は自分で最初から情報を作り直すということはあまりしないものです。そのため、エンジニア以外も参加しやすいフォーマットであるワードはよいツールだと思います。
ドキュメントを制する人がプロジェクトを制するケースもあると思うので、ご興味がある方は試してもらえると幸いです。
参考資料
この記事は参考になりましたか?
既に会員の方はを行ってください。
- ドキュメント作成にはMS-Wordを使おう連載記事一覧
-
- 【複数の人でドキュメント作成】MS-Wordを使ってスムーズなチーム開発をしよう
- MS-Wordで実用的なドキュメント作成、使うメリットと注意点とは?
- この記事の著者
-
WINGSプロジェクト 小林 昌弘(コバヤシ マサヒロ)
< WINGSプロジェクト について> 有限会社 WINGSプロジェクト が運営する、テクニカル執筆コミュニティ(代表 ...
※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です
-
山田 祥寛(ヤマダ ヨシヒロ)
静岡県榛原町生まれ。一橋大学経済学部卒業後、NECにてシステム企画業務に携わるが、2003年4月に念願かなってフリーライターに転身。Microsoft MVP for Visual Studio and Development Technologies。執筆コミュニティ「WINGSプロジェクト」代表。主な著書に「独習シリーズ(Java・C#・Python・PHP・Ruby・JSP&サーブレットなど)」「速習シリーズ(ASP.NET Core・Vue.js・React・TypeScript・ECMAScript、Laravelなど)」「改訂3版JavaScript本格入門」「これからはじめるLaravel実践入門」「はじめてのAndroidアプリ開発 Kotlin編 」他、著書多数。
※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です
この記事は参考になりましたか?
この記事をシェア
