データベースのユーザーマニュアルの作成方法（7つのステップ）
Alrightty! 誰がユーザーマニュアルを話すことに興奮していますか？
いいか分かった しかし、あなたが私のような人なら、プロセス&システムを文書化することは非営利団体にとって不可欠であることに同意します。 それはそれをする時間を見つけることのちょうど問題である。
そして、なぜ私たちはしないでしょうか？ ドキュメントは、長期的には私たちの時間を節約します。 不必要な会議&のトラブルシューティングから、スタッフが自分の答えを見つけることができるようになります。
言うまでもなく、それは持っているくそ良いスキルです。 そして、それはあなたの仕事を維持するために重要です、あなたは&あなたの組織の部分の方法が必要です。
これを行うための時間を脇に置いてみてください。 以下の手順は、これを可能な限り無痛にするのに役立つはずです…そうでない場合は、あなたがつかみたいと思う終わりに向かって”景品”があります。
輪郭から始めなさい。
プロシージャと定義を入力する前に、ドキュメントの構造を検討してください。 スタッフがフォローしやすいトピックは何ですか？ そして、どのような構造は、時間の経過とともに更新するのが簡単になりますか？
ネタバレ：これがあなたの目次になります！
example…my チームのSalesforceマニュアルは、主にオブジェクトによって分割されています。 しかし、設定によっては、部門や機能別にトピックを分割する方が理にかなっている場合があります。
ブロードを起動します。 その後、狭い。
あなたのマニュアルは、具体的な詳細とステップバイステップの指示を持っているようにバインドされています。 基本的には、私たちの同僚が忘れ続けるすべてのもの。
しかし、良い文書はまた、あなたのシステムがどのように組織されているかの有用な、鳥瞰図を与えるでしょう&なぜ。 ステップ1のあなたの輪郭を計画すると同時にそれを心に留めておきなさい。
p.s.データモデルを図化することを強くお勧めします。 Google Drawingsのような無料のツールを使用するか、WordやPowerpointのドキュメント（shapes&linesを使用）で何かを構築することができます。 ファンシーである必要はありません！
すべてのデータを定義します。
あなたのデータベース内のすべての技術資産は、人（寄付者、ボランティアなど）、取引（寄付、助成金など）のいずれであろうと、実際の”もの”の現れです。.）、またはパートナーシップ（プログラム配信）。
良い文書は、あなたのオブジェクト&フィールドが実際の世界で表すものを定義することによって、現実と技術の間のギャップを埋めるでしょう。
ユーザーに指示します。
ユーザーマニュアルは、定義と指示の二つのことを行う必要があります。
スタッフがあなたのデータベース内のタスクを実行する必要がある場合–データ入力、データ更新、さらには検索–それらのことのためのステップバイステップの指示を含めることによってそれらを助けます。
ヒント：番号付きリスト&短い文章はここにあなたの友人です。
すべてを一度書いてください。 その後、繰り返し、トリム。
私たちは皆、長い、言葉で、テキストで窒息したマニュアルを読むことの痛みを知っています。 あなたの同僚を惜しまない。 その最初の草案を強打し、それをトリミングする時間の多くを使うことを計画しなさい。
なぜ？ より少しが多くであるので。 そして、それはまだ簡潔でありながら、包括的かつ効果的である文書をまとめるために時間がかかります。
p.s.簡潔にするために物事を切り捨てると言っているわけではありません。 私は簡潔な文書は最初の試みに着陸しない芸術的なものであると言っています。
空白を使用します。
これはUX（ユーザーエクスペリエンス）の観点から考えてください。 あなたのデータベースがユーザーフレンドリーであることを気にするのと同じように、あなたはまた、あなたのマニュア
空白が多いほど、テキストの間/周りの間隔が良くなります。 また、フォントサイズ、行の高さ、箇条書きの間隔も考慮してください。
あなたがする必要がある場合にのみ、スクリーンショットを使用してください。
なぜあなたがそれらを示すことができるときに誰かに何かを説明するのですか？
しかし、私は個人的に彼らは罠のビットだと信じています。 少なくともそれはドキュメントに来るとき。
それについて考えてみてください。 システムのインターフェイスに何か変更があった場合は、それらの画像を再取得して置き換える必要があります。 彼らはまた、あなたが夢中になる場合は特に、あなたの書かれた指示からそらすことができます。
そのため、私は主にユーザーが見逃している可能性のあるものを強調するためにそれらを使用します。
🌟 助けになるかもしれないもう一つのこと….
今、私たちのステップを持っていることを、それは構築を開始する時間です！ 助けるために、私はそれを望んでいる人と共有しているユーザーマニュアルテンプレートを作成しました–Microsoft WordやGoogle Docsのために！
必要なのはメールアドレスだけです。 それをチェックアウトし、あなたのコピーをつかむには、このリンクに従ってください。
これはデータベースのブログですので、一つの簡単なメモ！ テンプレートを受信するためにサインアップすることで、あなたはまた、（私は第三者と共有することはありません）私のブログの電子メールリストに追 私はあなたがいつでもオプトアウトすることができ、隔月の更新と時折発表を送信します。