サポートドキュメントに含めるコア要素は何ですか？ [閉まっている]

Question

翌月にサポートグループに「引き渡し」が必要なアプリケーションを作成しました。

アプリケーションはかなり小さい（2か月の開発）であり、2つのクライアント側アプリケーションとデータベースで構成され、Windowsプラットフォーム用にc＃で記述されています。

サポートドキュメントに何を含めるかについての幅広いアイデアがありますが、これまでのキャリアでサポートドキュメントをあまり作成する必要はなく、アイテムの強固なリストが必要です。含める。

目標は、サポートグループの全員の生活をより簡単に、できるだけストレスのないものにすることだと思います。

だから私の質問は：

1. サポートドキュメントに絶対に含めるべき内容

2. サポートドキュメントに追加で追加するものを追加すると、さらに便利になります。

3. すべての生活を楽にするために、引き渡し前に他にできることは何ですか？

Answer 1

このプロセスの両方の側面を専門的に行っているので、次のことを 必須 にする必要があると言えます。

• コードのドキュメント（javadoc、doxygenなど）
• ビルドプロセスの詳細
  • 現在のソースを取得する場所
  • バグを報告する方法（発生します）
  • ソースまたは顧客にパッチを提供するルート
• どのように機能するか（単純ですが、しばしば見落とされます）
• ユーザーがカスタマイズ可能な部分（スクリプトコンポーネントなど）
• 各コンポーネントのプライマリ連絡先、別名エスカレーションパス
• 他に見たいことについてのサポートからのフィードバックの奨励

他にも多くのものを追加できると確信していますが、これらが私の最優先事項です。

Answer 2

1. 機能仕様（ある場合）
2. ユーザーマニュアル。お持ちでない場合は作成してください
3. 技術マニュアル、含む
   • 展開図
   • 使用するソフトウェア
   • 構成とビルドの詳細
   • サーバーIPおよびadmin / oracle / websphereパスワードの詳細
4. テストドキュメント
5. ドキュメントの概要
   • すべてのドキュメントが保管される場所
   • バージョン管理リポジトリとそのプロジェクト/ユーザーの詳細
   • アプリケーションのユーザー名/パスワード
6. 分析、データの読み込みなどのために、開発チームが作成したSQL /ツールなどをサポートします。

Answer 3

1. 操作と出力のスクリーンショットを含めます。
2. 「オンラインで簡単に更新可能」を優先する紙またはpdfの代わりにdoc（wikiのような）。
3. オンラインの場合、検索可能にし、クロスリンクします。

Answer 4

• ユーザーマニュアルはきちんとしたものです（写真、説明、麻生）。
• アプリケーション内のさまざまな機能の要約

これが＆quot; only＆quot;の場合、頭の上で考えていることサポートスタッフ向けであり、それ以上の開発ではありません。