11-1 技術文書の見直し方－技術文書チェックリスト－

　書き終えた後に内容を確認して誤りを正しただけでは、技術文書を見直したことになりません。

ここでの「技術文書の見直し」

　　内容が正しいか否かというより「技術文書としての表し方が適切であるか」を確認して必要なら正すこと

　書き上げた後の技術文書には、文の表し方や用語の使い方といった見直すべき点がいくつも残っている可能性があります。これらを確認項目に基づいて適切に正すことは、わかりやすい技術文書の作成に役立つだけでなく、文書作成力の向上につながります。

　今回は、見出し、段落、文、用語といった項目ごとに確認すべき事項をあげてゆきます。　　

1.     「技術文書がわかりづらい」と言われる原因

2.     「確認項目ごとの見直し」の重要性

3.     「確認項目ごとの見直し」の対象と順序

4.     確認：文書の基本方針・前提

5.     確認：技術文書の基本事項

6.     確認：見出し構成と見出し名

7.     確認：段落の構成・長さ

8.     確認：箇条書きおよび副本文・注記の使い方

9.     確認：図・表の使い方

10. 　 確認：文の表し方

11. 　 確認：用語の使い方

12. 　 確認：曖昧な表現の有無

13. 　 確認：冗長な表現の有無

14. 　 確認：列挙の表し方

15. 　 確認：句読点および記号の使い方

16. 　 確認：ページ、段落および見出しの書式

17. 　 確認：ページ末の空きと行のはみ出しの調整

18. 　 確認：前付け・後付けの表し方

19. 　 見直しの進め方

まとめ

後　記

© Yamanouchi Takaaki 2024

　　　［注］今回のテーマは他の回と関連するため、以前に解説した内容と重複する箇所があります。

ブログの本文は、下記のPDFファイルで閲覧できます。

本文のPDFファイル（A4判・全33ページ）

【重要】　PDFファイルの表示に伴うトラブルへの責任は、一切負いません。

　ブログではタイトルを開いたページに本文を表すのが普通ですが、あえてワープロで作成した本文をPDFファイルにして概要・目次に添付しました。HTML形式ではワープロ文書の表し方を解説しきれないというのがその理由です。

l　PDFファイルは、5MB以内です。使用する閲覧ソフトウェアによって表示の細部が若干異なる場合があります。

l　PDFファイルの利用は、閲覧のみです。共有やダウンロードなどのご要望には応じかねます。