documentation - 適切な展開ドキュメントにはどのような情報が含まれますか?

Question

私は、展開ドキュメントの構成に関して同僚と絶え間なく戦いを繰り広げています。

文書が必要であることに誰もが同意します。特に大規模なリリース、バグ修正、および機能強化を区別するために、どのレベルの詳細を含める必要があるかについて、誰もが共通の基盤を見つけることができるわけではありません。

何があなたにとって最も効果的であると思いましたか?

Answer 1

ワンクリックで展開できるツールを構築することは、完全な展開ドキュメントよりもはるかに優れていることがわかりました。

Answer 2

ドキュメントの目的が、コードが再現可能な方法でデプロイされることを確認することである場合、次のことは最低限推奨される方法です。

1. リリースの概要、変更点、バージョン、ソリューション ファイルの場所など。
2. 可能な依存関係を一覧表示する
3. 詳細な導入手順
4. インストールに必要なデータベースの変更またはスクリプト
5. アプリケーションの構成方法に関する構成の概要。
6. インストールが動作していることを確認するために実行できる主要な機能テスト。
7. ロールバック手順 - 必要な場合。

Answer 3

ドキュメントの目的は何ですか? そこから始めて、その目標を達成するものを見つけてください。

私たちの目標は、グループにまったく新しい人が、いくつかの異なるシステムに対して新しい展開または更新された展開を実行できるようにすることでした。Windows サービス、cron ジョブ、データベースのバックアップ、Web サイトの更新など、基本的な操作を行っています。

いずれの場合も、詳細レベルは、システムと、新しいチーム メンバーが更新と新しい展開を実行するために必要なものに基づいていました。