レビューチェックリストを使った ドキュメント品質改善方法
こんにちは。株式会社クレスコ・デジタルテクノロジーズのY.Iです。ITエンジニア歴は10年以上になります。日々業務をしていく中で、ドキュメントを作成してお客様に提出する場面が多くあります。そうした場合には、内容の誤りや誤字脱字などがない品質の高いドキュメントを提供する必要があります。そこで本記事では、ドキュメント品質改善をテーマに情報を展開したいと思います。
目次[非表示]
- 1.業務におけるドキュメントレビューチェックの実施
- 2.レビューチェック観点のご紹介
- 3.公用文作成の考え方
- 4.レビュー前に実施すると便利なもの
- 5.まとめ
- 6.引用元
業務におけるドキュメントレビューチェックの実施
私が担当している業務では、お客様にドキュメントを提出する前にチェックリストを使用して確認を行うことで、ドキュメント品質や報告内容の改善・向上に努めています。
一例として、お客様のシステムを検査する業務では下記のような流れになっています。
赤字になっている項目でチェックリストを使用して確認を行っています。
レビューチェック観点のご紹介
検査業務の一連の流れに記載したとおり、実施計画書、速報、検査報告書はドキュメント作成後にレビューチェックリストに沿って内容に問題ないかを確認してから提出しています。
レビューチェックリストの観点の一部を下表にまとめます。
上表の確認内容の中に、ワードの文章校正機能を使用した表記揺らぎの確認がありますが、本機能ではカバーしきれない表記揺らぎも存在します。
そうしたケースに対応するための手段として、文化審議会が作成している、「公用文作成の考え方」を用いることが出来ます。
公用文作成の考え方
業務において表記揺らぎの確認をするために使っている「公用文作成の考え方」という文書について、その内容をご紹介します。
「公用文作成の考え方」とは、昭和26年に国語審議会が建議した「公用文作成の要領」が示してきた理念を生かしつつこれを見直し、政府内における公用文作成の手引として活用されることを目指し取りまとめられたものです。
本文書では、漢字を使う場合には原則として常用漢字表に含まれる漢字及び採用されている音訓を用いることが示されています。
代表的な正誤表現を下表にまとめます。
レビュー前に実施すると便利なもの
レビュー前のドキュメント作成時にミスをしにくい仕組みを作ることが大切だと感じていますので、普段気を付けている点の一部を記載します。
Windows端末
- ファイルの中身を確認したい時は「右クリック」→「新規」を選択します。
→普通にファイルを開くと誤って更新して保存する可能性がありますが、「新規」で開くとその可能性がなくなるので、安全です。
- 今開いているエクスプローラーと同じ階層を確認したい場合は、「Ctrl + N」します。
→ワードやサクラエディタなどで「Ctrl + N」すると新規のファイルが作成されます。
- ファイル名やフォルダ名を変更したい場合は、ファイルやフォルダを選択した後、「右クリック」→「名前の変更」ではなく、F2キーで編集します。
→右クリック～で実施しようとすると削除がすぐ下にあるので、誤って削除するおそれがあります。上記のようにすると事故がなくなります。
ワード
- 直前と同じ処理を実行するにはF4キーを押下します。
→表の行追加などでこれを使用すると効率よく作業できます。
- 「書式のコピー/貼り付け」を使用すると、コピー元の書式設定を貼り付け先に持っていくことができます。
→ドキュメント内の書式を統一したい時に使用します。
- 他で編集した文章をワードに貼り付ける時は、「貼り付けのオプション」の中で「テキストのみ保持」を選択します。
→ワードで使用している書式に合わせた形で貼り付けられます。
- 本文中で図表番号を参照する場合は、相互参照するようにします。また、図表番号が更新された場合は、右クリック→「フィールド更新」を選択します。
- 表のNoは手動入力ではなく、自動で採番します。
→行の追加や入れ替えをしても、行番号が正しいものに変換されるため、ミスの軽減になります。
まとめ
今回、ドキュメント品質を向上させる方法について紹介しました。レビューチェックリストを使用することで、誰がレビューを実施してもドキュメントが一定レベルの品質となります。作業していく中で随時更新していけばより質の高い成果物になると思います。また、計画書や報告書などの雛形がメンテナンスしやすいフォーマットであること、脆弱性を検出した際に参考とする過去の検出事項一覧の整備なども大事な点だと実感しています。
■サービス資料一覧はこちら
引用元
文化審議会建議「公用文作成の考え方」について | 文化庁
https://www.bunka.go.jp/koho_hodo_oshirase/hodohappyo/93650001.html
文化庁 | 国語施策・日本語教育 | 国語施策情報 | 内閣告示・内閣訓令 | 常用漢字表（平成22年内閣告示第2号）https://www.bunka.go.jp/kokugo_nihongo/sisaku/joho/joho/kijun/naikaku/kanji
