マニュアルの書き方
概要:全体から細部へ
ざっくりとそれが何なのか、何ができるのかを概要で説明
操作手順:操作と結果は分けて書く
(例)
「高」「中」「低」のいずれかのセキュリティレベルを選択して、
[はい]をクリックします。
セキュリティレベルが変更されます。
※エンタープライズジンの「ほんのすこし書き方に注意すれば、あなたのドキュメントはさらに分かりやすくなる! 」から引用
マニュアルの書き方
概要:全体から細部へ
ざっくりとそれが何なのか、何ができるのかを概要で説明
操作手順:操作と結果は分けて書く
(例)
「高」「中」「低」のいずれかのセキュリティレベルを選択して、
[はい]をクリックします。
セキュリティレベルが変更されます。
※エンタープライズジンの「ほんのすこし書き方に注意すれば、あなたのドキュメントはさらに分かりやすくなる! 」から引用
■議論で最も重要なのは前提の共有
「今回はXXXXXをYYYYの観点とZZZZの観点に立って考え、こういう結論に至りました、さぁどうですか?」というのがあるべきスタート
※GoTheDistance の知らないと損するフレームワーク思考活用法から引用