7

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

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

サポート ドキュメントに何を含めるべきかについては大まかな考えがありますが、これまでのキャリアであまり多くのサポート ドキュメントを作成する必要がなかったため、含めるべき項目のしっかりとしたリストが必要です。

私の目標は、サポート グループの全員の生活を楽にし、できるだけストレスをなくすことだと思います。

だから私は私の質問は次のとおりだと思います：

  1. サポート ドキュメントに絶対に含める必要があるもの

  2. サポート ドキュメントをさらに便利にするために、サポート ドキュメントに追加したものは何ですか。

  3. 私たちのすべての生活を楽にするために、引き渡し前に他にどのような活動を行うことができますか?

4

4 に答える 4

13

専門的にこのプロセスの両面に携わってきたので、次のことは必須であると言えます。

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

他にもたくさん追加できると思いますが、これらは私の心の中で最優先事項です。

于 2008-10-15T16:22:50.073 に答える
6
  1. 機能仕様 (お持ちの場合)
  2. ユーザーマニュアル。お持ちでない場合は作成してください
  3. 技術マニュアル、含む
    • 配置図
    • 使用ソフトウェア
    • 構成とビルドの詳細
    • サーバー IP および admin / oracle / websphere パスワードの詳細
  4. テスト ドキュメント
  5. 概要資料配付
    • すべての書類が保管されている場所
    • バージョン管理リポジトリとそのプロジェクト/ユーザーの詳細
    • アプリケーションのユーザー名/パスワード
  6. 分析、データのロードなどのために、開発チームによって作成された SQL やツールなどをサポートします。
于 2008-10-15T16:36:39.687 に答える
2
  1. 操作と出力のスクリーンショットを含めます。
  2. 紙や PDF ではなく、「オンラインで簡単に更新できる」ドキュメント (wiki のようなもの) を優先します。
  3. オンラインの場合は、検索可能にして相互リンクできるようにします。
于 2008-10-15T16:20:01.857 に答える
0
  • ユーザーマニュアルはきちんとしたものです（写真、説明、aso。）
  • アプリケーション内のさまざまな機能の概要

これがサポートスタッフの「のみ」であり、さらなる開発ではない場合、私は頭の上で考えています。

于 2008-10-15T16:23:56.903 に答える