マニュアル執筆が怖くなくなる、12の執筆ポイント
前回「『目次』の良し悪しが、すべてのマニュアルの良し悪しを決める」に引き続き、分かりやすいユーザーマニュアルの作成ポイントを説明します。前回は「構成」について説明しました。今回は「表現方法」についてです。 「操作マニュアル」「業務マニュアル」「障害対応マニュアル」 について、全部で12のポイントを解説します。 操作マニュアルを記述する 1．読み手に分かりやすい流れを考える ユーザーが操作マニュアルから知りたいことは「操作手順」と「操作の結果」です。 操作マニュアルでは、これらの情報を、「画面のイメージ」と「説明文」の組み合わせで表現します。 ＋ 操作の結果 操作の結果を表示する画面 処理内容や操作結果を説明する文章 ただし、一般的にシステムの操作は、次のような流れになります。 表示されている画面で操作を行う ↓ 結果の画面に遷移し、新たな画面が表示される≫ ↓ 表示されている画面で次の操作
文書ごとに最適な「構成のフレームワーク」は異なる
「提案書」や「要件定義書」は書くのが難しい。読む人がITの専門家ではないからだ。専門用語を使わず、高度な内容を的確に伝えるにはどうすればいいか。「提案書」「要件定義書」の書き方を通じて、「誰にでも伝わる」文章術を伝授する。 第3回「分かりやすい提案書はアウトラインが美しい」、第4回「『要件定義書のアウトライン作成』完全マニュアル」で説明したように、全体を「階層構造」にすると文章が読みやすくなります。特に、提案書や要件定義書、マニュアルのようにページ数が多い文書は、必ず階層構造にしましょう。さて、今回は「階層構造を作った次のステップ」を説明します。 いきなり文章を書き始めるのはNG 階層構造を作ったら、いよいよ中身の文章を記述します。このとき、思いつくままに文章を記述し始めてはいけません。分かりやすい文書にするためには、いきなり文章を書くのではなく「表現の構成」を考える必要があります。 「表
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
