3'理解の成功ドキュメントプロジェクト'第1'

ユーザーマニュアルの作成は、ソフトウェアプロジェクトの大きなコンポーネントです。頻繁に過小評価さ残念ながら、だと最後まで残しました。しかし、それはそれは良い経営計画がなければならないことを意味しません。

これは3つのシリーズ記事の良いユーザマニュアルプロセスの重要な要素の概要を初めてだ。それは理想的な'プロセスのようなものだ、非常にいくつかのプロジェクトは、すべてのステップを実装することができる、いくつかの追加の手順が必要になります。それにもかかわらず、それは良い基盤（特に場合は、ユーザーのドキュメント管理に新しいしていると）を提供する必要があります。

ここでは3つの記事の概要です。

第1条（この記事）'を理解する

あなたの範囲を識別する
'慣れる作業環境と自分
'慣れ親しんで製品を自分で
ドキュメントの'特定聴衆
'を指定する知覚者の要件
'約見積もりドキュメンタリープロジェクトの期間とリソース
'研究者の要件

第2は指定'

'状態の目標
'を書くのコンセプト仕様
'デザインいくつかの可能な実装
あなたのプロトタイプ'行動ユーザビリティテスト
'を書く要求仕様
の見積もりプロジェクトの期間＆リソース
あなたのサンプルを書くに'行動ユーザビリティテスト
'を書く作業pracs＆デザイン仕様

第3条の書込み

'をお書きくださいドキュメンタリー
'管理生産

だからここ行く

理解プロジェクトの企画

特定の範囲

すべてのプロジェクトの最初のステップは、まさにあなたが行うことが期待している特定することです。一般に、この前に仕事に就くが起こるか、それはまだ最初は、ドキュメントする必要があります。あなたのスコープは、どこに合わせて把握が含ま識別あなたの会社内に収まるよう、開発プロセス全体で、どこ。マニュアルがないプロジェクトは、これまでただのマニュアルですので、重要な、まさに他の関与している知っていることです。いくつかの他の分野、ドキュメントの人々は/で一般的にinclude関与する必要がありますのとおりである：

'仕様のレビュー
のGUIの評価
'製品ユーザーからの要求の研究
'ドキュメントの聴衆の要件研究
'ユーザビリティテスト

これらすべてのものの開発プロセスに不可欠であり、適切にスケジュールする必要があります。

慣れ親しんで自分作業環境で

誰もが製品に関与を知って取得します。ソフトウェアプロジェクトでは、これはプロジェクトマネージャー、デザイナー、低レベルのコーディングことになるだろう人を意味しますが、彼らと実際に良好な関係を持ってみてください。彼らはあなたを尊重するが、それはつもりはないがあなたが持っているものもの言うことに耳を傾ける。

慣れ親しんで自分製品に

どのような製品に関与することが起こっているかして下さい。あなたが知る必要があります：

'どのような開発の目標は
'何を満たすとしているユーザの要件
'どのように製品が使用されます
'誰がそれを使用する
'どのような製品の機能があります
'どのように製品の外観と感じる
'これは、特定のドキュメンタリーの設計を必要とするのだろうか？例えば、それだけでWindowsの最新バージョンで実行することが、それは）など、特定の外観と感じて、特定の環境（ヘルプが統合される可能性があります可能性があります

これらはあなたがに入力があるかもしれないすべてのもの、単純な批判、または入力からいずれかを介してユーザーの研究の要件にしている。ように見つけることができる限りドキュメントを読んで、試してみてのインタビュー、可能な限り多くの人々の利害関係者。あなたが行くように、識別すべての問題を、あなたがして、または何かのニーズが異なることだと思います質問書き留める。

いくつかの（非人間）のソースは、これが含まれて達成するために活用することができます：

'特徴と製品仕様
'プロジェクトが計画
'資金アプリケーションのマニュアル該当する場合

ドキュメントを特定対象

プロジェクトマネージャー（およびその他のステークホルダーのespと話し合う。マーケティング）/観客知覚ユーザーです。

指定知覚対象の要件

場合は、製品の持続時間とリソース要件の大まかな見積もりを提供できるようになりますので、視聴者の要件についてはいくつかの推測を確認します。

プロジェクトマネージャー（およびその他のステークホルダーのespと論議は、マーケティング）知覚ユーザーの要件は、ヘルプを満たす必要があります。誰かがユーザーの目標、タスク、および精神的なモデルのユーザーを研究している場合に、製品（または類似製品）を使用し採用してください。彼らはしていない場合は、面接社内の専門家は目標を、タスク、精神的なモデルなど知覚識別するために

第二に、どのような理論についてはユーザーマニュアル（すなわちドキュメントのアプローチは、視覚配慮、インデックスの配慮等）の意見を識別してください。私はニュルンベルク目標到達プロセスを超えてミニマリズムをお勧めします、（1998）のJohn M.キャロル編集。

約見積もりドキュメンタリープロジェクトの期間とリソース

、あなたは本当に十分などのくらいのドキュメントが完了することを知って約製品やオーディエンスの要件を知らない、この段階でも、経営陣はそれにもかかわらず概算を気に入るだろう。これは、[OK]を、として、誰もが知っている限りですがそれは非常に大まかな見積もりであり、さらに知識や研究を保留中の変更されること。

この最初の見積もりはすべてする前に発生し、書き込み段階の後の段階で費やすことになる時間を組み込む必要があります。、これらの段階が重要であり、しています。短期変更することはしないでください。（ヒント：うまく管理プロジェクトでは、計画は、50％、生産19％ライティング、あなたの時間の約30％を取得して評価1％）。

中古執筆段階の推定

中古執筆段階での許可書き込みを可能にするよりもトリッキーです。あなたが問題を抱えている場合は、その他のすべての見積もりを基に、ガイドとして上記の数字を使用して書く段階を推定する。

ライティングとポストを書く段階の推定

あなたはおそらくまだ主に過去の記録、経験、直感（本能的に感じる）の組み合わせに基づいてされ、目標とタスクとの組み合わせで、業界標準製品やユーザーは、あなたの見積もりについてはこちら多くのことを知らないので、あなたが既に指定されている。次の手順で起動します。

1。見積作業量は、ユーザーが自分の目標を達成するために実行する必要がタスクを文書化することが必要です。
あなたの時間、過去、現在の量の見積もりと同様のドキュメンタリーを生成する撮影の参照を横断できるかどうか2。トラックは、以前ドキュメンタリーレコードダウンします。参照してください。図は、このメソッドに基づいて導出する。
3。この方法は推定業界の標準数値（例えば派生と比較参照してください、私は現在の業界標準は、この'ドキュメントの1ページあたりの1日は、すべてのドラフトやレビューをカバーする）ようにだと思います。
4。2つの図を比較し、適切な妥協点を自分の経験や勘に基づいて決定されます。
あなたが実際にしてどのくらいの5は、図をし、どのように多くの作家は、それがこの期間中に終わらせる必要があります、それを行うには。
6。描画がプロジェクトのスケジュールをMicrosoft Projectのようなものを使用して採用、研修のための時間を可能にする忘れてはいけないと労働慣行を書く。

TIPは：この段階で、あなたはドキュメンテーションプロジェクト計画の最初のドラフトを書く必要があります。これは、含める必要がありますまたはすべての手順を実行しますこのドキュメントで説明を参照して基本的に、それはプロセスをここに提唱反映すべきが、プロジェクトに固有のものを'が再作業それもタイムラインを含める必要があります。

研究対象の要件

研究製品のユーザーとドキュメントの観客は1つの任意の成功製品の最も重要な部分の一つです。残念ながら、それはまた、1つの任意のプロジェクトの最も見落とされがちな側面の一つです。意思決定者はすでに、を感じるので、これは一般的に発生します。ほとんどすべてがユーザーと観客を知る知っている。

管理ドキュメントプロジェクトでは、あなたが研究を行う機会を調査する必要が場合。あなたが後半に製品のライフサイクルで採用している場合、ユーザーの研究は、すでに製品自体の行われている場合は、質問してください。それがある場合は、そこにあるあなたが聴衆の研究のためのサポートを得ることは良い機会。

視聴者の研究では、識別するために求める必要があります：

'ユーザーの目標（どのようなユーザーが製品を達成したいと考えて）
'ドキュメンタリー（マニュアルのユーザの期待を？オンラインヘルプ？チュートリアル？、ユーザビリティの要件、ローカライズの要件など）
'ユーザーメンタルモデル（どのように彼らはすでに、オンラインヘルプを参照してくださいどのような印象を、彼らはそれ等がある）
'ユーザーのタスク（どのようにユーザーが自分の目標を達成するために製品を使用する）
'ユーザーが実行するかのタスク（ユーザ/タスク行列）
'これらのタスクを行ってどのくらいのユーザーがありますか？
'どのタスクは1オフになって、どの繰り返しですか？
'彼らがこれまで異なるそれを行うのですか？
'彼らは、タスクの様々なまたはわずか数か？
'彼らがそれをやって嫌いですか？（それは退屈な、反復？）
'彼らが見つけるのですか、それは難しい？
'どのタスクが不可欠であると考えですか？
'は通常圧力時、彼らは作業を行うの下ですか？
'他の気晴らしは、（環境、社会、など）ですか？

いくつかの研究方法は、考慮すべきです：

'観測ユーザーの作業環境で仕事を行うための
'フォーカスグループインタビューのユーザーと
'アンケート

ヒント：これらのメソッドの詳細については、インタフェース設計のためのHackos＆暗赤色（1998）、社会的マーケティングをユーザとタスク分析Hackosであなたのドキュメントプロジェクトの管理を見て（1994）を取る：新しい命令を公衆衛生のためのマノフで（1985年）、マーシャル＆ロスマン（1995）第2版を質的研究の設計、および'がフォーカスグループのガイドを実施するタイナン＆ドレイトンのマーケティングインテリジェンスと計画の最初のタイムユーザー'、（1988）。

するためにはあなたの仕様を準備については、この資料の参照してくださいパート2継続される。

3'理解の成功ドキュメントプロジェクト'第1'