ワープロソフトウェアでの作り方（内容ではない）部分にフォーカスした話です。 日本UNIXユーザ会2019年度定期総会併設勉強会での発表資料です。 https://www.jus.or.jp/blog/archives/1085

1. 榎 真治 (shinji.enoki@gmail.com)
in
日本 UNIX ユーザ会 2019 年度定期総会併設勉強会
2019-07-20 This work is licensed under a Creative Commons
Attribution-ShareAlike 4.0 Unported License.
ワープロソフトウェアでの正しい文章の作り方
- 概論 & デモ 編 -

2. 自己紹介：榎真治
● 日本UNIXユーザ会幹事(2011-)
● LibreOfficeコミュニティ
● LibreOffice日本語チームメンバー(2011-)
● The Document Foundationメンバー(2014-)
● TDF認定マイグレーションプロフェッショナル
● ドキュメンテーションの集い(2019-)

3. 今回の「正しい文章の作り方」とは？
● ワープロ文書のセオリーを無視されることが多い
● jusの資料でも保守しずらい文書があった
● 目的に応じて、セオリーに沿ったワープロ文書を作って
おけばメンテが楽になる
● 今日は、内容ではなく「作り方」を良くする方法を考え
る

4. ワープロ文書の良くない例：jus総会資料から
● レイアウト問題
● フォントが環境依存
● タブのリーダー設定してない
● 行間の調整がおかしい
● 更新しにくさ
● 目次を自動生成していない
● 見出しなどスタイル使っていない
● 番外：PDFを結合している
● LibreOfficeならマスタードキュメント
デモ

5. ドキュメントの品質を考えてみた（例）
● 状況によって必要なもの、書き方になっている（合目的性）
● 理解しやすい、読みやすい（ユーザビリティ）
● 曖昧でなく、首尾一貫している
● 間違いがない（正確性）
● メンテナンスしやすい、時代が変わってもメンテナンス可能
（保守性）
● 他の人や環境とやりとりしやすい（相互運用性）
ソフトウェア品質特性に近いかも

6. 「中身」と「作り方」に分けると
● 状況によって必要なもの、書き方になっている（合目的性）
● 理解しやすい、読みやすい（ユーザビリティ）
● 曖昧でなく、首尾一貫している
● 間違いがない（正確性）
● メンテナンスしやすい、時代が変わってもメンテナンス可能
（保守性）
● 他の人や環境とやりとりしやすい（相互運用性）
中身
作り方

7. 作り方も大事
● 作りが悪いと
● 理解しずらい、読みにくい
● メンテしにくい
● 他の環境で困る。編集できる人が限られる
● 作り方は、簡単なノウハウで良くなる
● 作り方は、仕組みでサポートできる
● 構造化ドキュメントもその1つ

8. 構造化ドキュメントとは
● 見出しなど役割別に定義し、階層構造を作る
● 構造を一貫して扱う
● コンテンツとスタイルを分離する
● Webのスタイルシートも

9. 構造化の例
● 見出しや本文といった役割ごとの要素の構造に分ける
● 例えば...
● 見出し1、見出し2、見出し3：3-4レベル程度
● 本文
● ヘッダ、フッタ
● 表
● リスト
執筆用テンプレート参照

10. 保守性をどこまで重視する？
● 更新頻度や更新量にもよる
● 作り方によって、変更コストが変わる
● 一方で作成コストはあまり変わらない
● 間違った変更がしやすい/しにくい
● 同じことを変更する箇所が複数あると更新漏れする、
など

11. 保守性の例
● 変更必要なところがわかりやすい
● 同じことを複数で変更する必要があるか
● 変更して文書が壊れないか

12. 相互運用性をどこまで重視する？
● 長期に渡ったり、様々な人が読み書きする場合は重要に
● OS、ワープロソフトなどのツール、フォントなどの違い
● 標準にどこまで準拠させるか
● 思ったよりも、広範囲の相互運用性が必要になるケースも多い
● 相互運用性が高い構造なら、個々の環境をそこまで意識しなくて
もよいことも（標準化の進んだ世界なら）
● 完璧な相互運用性は存在しない。どこまでやるか

13. 相互運用性の例
● ファイル形式：ODF、OOXML
● どの形式を選ぶか？そのソフトが標準に準拠してないこ
とも（WordはOOXMLの標準からズレていることも）
● OS:Windows、MacOS、Linux
● ツール：MS Word、LibreOffice Writer
● フォント：自由に使えるフォントを使う、OSやツールに付
属するフォントを使う場合は注意が必要

14. デモ：jus総会資料を作り変えてみる
● どこまで出来るかわかりませんが...
● 時間の許す範囲で

15. まとめ
● 文章では「作り方」も重要
● 構造化ドキュメントは有用
● ツールのサポートを使うと便利
● ライブで文書を作り直してみた

16. jus主催：ドキュメンテーションイベントのお知らせ
● 日時：8/24(土) 13:15-17:00
● 場所：日本工学院専門学校 蒲田キャンパス 3号館7F
● Open Developers Conference 2019の中で開催：LLと同時並行トラック
● 参加費：無料
● セミナー３本、パネルディスカッション１本
● 「専門学校教育におけるドキュメンテーションの役割」藤原 由来（神戸電子
専門学校/ソラソルファ）
● 「まだそんなドキュメントで消耗してるの？ 開発効率を上げる攻めのド
キュメンテーション」田中 一紀（株式会社ソニックガーデン 業務ハッカー）
● 「運用ドキュメント2019 ～ 手軽にスピーディに継続的に保守するためのド
キュメント入門～」波田野裕一（運用設計ラボ合同会社）