「マンガでわかる技術文書の書き方」の内容の説明の第14回として,「実践編」を説明します。
本書では最後の章で実践編を設けました。実践編は「理論と実際」での「実際」に対応します。「理論」とは,「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」が対応します。理論で学んだことを実際で確認していただくために実践編を設けました。
「理論と実際」の考え方は,書き方とその事例をペアで解説したことと同じです(「『マンガでわかる技術文書の書き方』の内容の説明:第10回」参照)。
具体的には,技術文書の修正前(Before)と修正後(After)の比較を解説しました。修正前と修正後を比較することで,「6つのルールと18の書き方」の実践での使い方がわかります。実践での使い方がわかれば,これが,日々のオンザジョブトレーニングのときの参考になります。
◆修正前(Before):内容が明確に伝わらない技術文書(=内容が伝わる技術文書)
本書では,修正前(Before)に対する修正後(After)を示し,具体的にどの書き方を使って修正したのかを解説しました。この解説を読めば,例えば,「『書き方1:要点を冒頭に書く』とは実践では(日々のオンザジョブトレーニングをするときには)このように使うのか」のようなことがわかります。
次回に続きます。