ベスト プラクティス - 早めにプロジェクトを定義しましょう
ヘルプ システムができるだけ成功するように保証するヘルプ開発手順にあたって早めに行うべきタスクがあります。これらのタスクは以下を含みます:
ドキュメンテーションプランの作成 テキスト エディタまたはワープロソフト(Microsoft Word など)を利用して、あなたのプロジェクトについての情報でできるだけいっぱい含む文書を作成します。思い浮かベル限り、質問を訊いて答えましょう、たとえば:
- 読者は誰でしょうか?
- 読者は複数ありますか?そして、読者ごとに違う出力が必要でしょうか?
- どんな題目を含めばよいでしょうか?
- 最終的オンライン出力の外見と振る舞いをどういうふうにしたいですか(ソフトウェアプログラム内で開く、自分の表示ウィンドウで開く、などなど。)?
- 何種類の出力を持ちますか(オンライン出力、印刷出力)?
- ヘルプ システムを評価してテストするのは誰ですか?
スタイルガイドを開発 ヘルプ システムについてのスタイル「規則」文書を作成します。詳細なスタイルガイドを作成することによって、ヘルプ システムを首尾一貫に保てて、後で仕事を複製することを避けられます。スタイルガイドは以下のような情報を含むでしょう:
- 指定の用語の綴り
- 使用する略語
- 書式の仕様(コマンドには太字を使用、表の見出しには最初の文字岳を大文字にする、など)
- 事前にプロジェクトを細かく定義するほど、いい結末になることを覚えましょう。
追加参照