技術文書の添削用のマニュアルとして使う(その1)

2022年3月末「マンガでわかる技術文書の書き方」を上梓しました。この本を読んだ知人(IT関連会社勤務:Aさんとします)から,「この本は,後輩や部下の書いた技術文書の添削用のマニュアルになる」という内容のメールをいただきました。

拙著を執筆したとき拙著がこのように読まれる(使われる)と想定していなかったので少し驚きました。でも,メールの内容を読み「なるほど」と思いました。Aさんのメールの内容は拙著の購入を検討していただくときの参考になるのでブログで紹介します。

Aさんは,「技術文書の添削用のマニュアルになる」と判断された理由を2つの視点から書いてくださいました。

1.会議の議事録を添削する場合
この会社では,システム開発の進捗状況を毎週報告する会議があります。プロジェクトマネージャーと各グループのリーダーだけが出席しますが,この会議の議事録は新人が担当します。この議事録を入社3年目ぐらいの社員が添削するのですが,Aさんも新人の議事録を添削しました。添削して気が付いたのは,議事録に「決定事項」や「継続検討課題」が明確に書いていないことでした。これらは,議事録を書くうえで重要な内容です。Aさんは,新人にこれらを書くように指示する必要がありましたが明確な修正指示が出せなかったとのことでした。

◆「マンガでわかる技術文書の書き方」がマニュアルとして使える内容注)
Aさんは,「以下の3つの内容が修正の指示として出せると考えました。

①書き方の第1原則:書き手と読み手の違いを認識する
会議の内容が詳細に議事録に書いてなくても会議に出席した人は議事録を読むだけでその内容が明確に伝わります。会議に出席した人は会議の内容を知っている人,すなわち,書き手と考えることができるからです。しかし,このような議事録では,会議に出席しなかった人はこの内容が明確に伝わりません。会議に出席しなかった人は会議の内容を知らない人,すなわち,読み手だからです。この書き手と読み手の違いを認識することで議事録の書き方が変わります。

②ルール3:分けて書く
③ルール6:明確に伝わる文を書く
②と③は,「決定事項」や「継続検討課題」を書くときに有効です。

注):「マンガでわかる技術文書の書き方」の中では,「内容が明確に伝わる技術文書の書き方の3原則」「6つのルールと18の書き方」技術文書の添削用のマニュアル(添削の基準)になります。

次回に続きます。

トップへ戻る