「技術文書を書く面白さを知る(技術文書を工夫して書く)(その2)」の中で以下のことを書きました。
「読み手に内容を明確に伝えるため技術文書をどのように書こうか?」と考えることで技術文書を工夫して書くようになるからです。
今回のブログでは,「技術文書を工夫して書く」について説明します。
■工夫して書くための2つのポイント
工夫して書くためには2つのポイントがあります。そこで,この2つのポイントについて解説します。
◆ポイントその1:内容が明確に伝わる技術文書の構成(ストーリー)を考える(構成を工夫する)
「内容が明確に伝わる技術文書の書き方の第2原則:内容が明確に伝わる構成を考える」を使って考えます(構成を工夫します)。ただし,構成(ストーリー)を考える必要がある技術文書を書くときが対象です。
業務報告書の場合には,「技術文書の構成(ストーリー)=目次」になります。例えば,以下のような場合です。
他の技術文書の場合にも,内容が明確に伝わる技術文書の構成(ストーリー)を考えてください。
◆ポイントその2:「6つのルールと18の書き方」での「18の書き方」を組み合わせて使う
「18の書き方」の大きな特徴が各書き方を組み合わせて使えることです。組み合わせて使うことで一層内容を明確に伝えることができます。
q
ここで,書き方の組み合わせ方を変えて以下の内容を3つのパターンで書いた例を示します。
q
【パターンⅠ:3つの書き方の組み合わせ】
①書き方6:かたまりに分けて書く(見出しを付ける)
②書き方10:強調して書く
③書き方11:まとまりを持たせて書く(反復・繰り返し)
P
【パターンⅡ:2つの書き方の組み合わせ】
①書き方8:表で書く(表の書き方を工夫する)
②書き方10:強調して書く
P
【パターンⅢ:3つの書き方の組み合わせ】
①書き方8:表で書く(表の書き方を工夫する)
②書き方9:写真や図を入れて書く
③書き方10:強調して書く
このように,「18の書き方」の組み合わせによって様々なパターンの技術文書の書き方があることがわかると思います。つまり,様々な書き方があることで技術文書を工夫して書くことができます。技術文書を書くことを「単なる作業」から解放するのが「技術文書を工夫して書く」です。
読み手の存在を認識し,「『書き方の第2原則と6つのルールと18の書き方をどのように使おうか?』と考えること」に技術文書を書く面白さがあります。「技術文書を工夫して書こう」という意識を常に持ってください。
■好きこそものの上手なれ
「技術文書を書く面白さを知る(技術文書を工夫して書く)(その1)」の中で「好きこそものの上手なれ」について説明しました。
これは,「技術文書を書く面白さを知る(技術文書を工夫して書く)」の発想の原点となる考え方です。以下の流れを認識してください。
「読み手の存在を認識」➡「技術文書を書くことが面白い」➡「技術文書を工夫して書く」➡「伝える力と書く力(内容が明確に伝わる技術文書を書く力)」がレベルアップする。
P
【参考図書】
森谷仁著,「マンガでわかる技術文書の書き方」,オーム社,令和4年3月25日