Welche Art von Informationen würde in gute Entfaltungs Dokumentation? [geschlossen]

Question

Ich habe diese ständigen Kämpfe mit meinen Kollegen in Bezug auf Zusammensetzung der Bereitstellungsdokumentation.

Alle sind sich einig, dass die Dokumentation erforderlich ist. Nicht jeder kann sich eine gemeinsame Grundlage finden auf welche Details gehen sollte in diese besonders Differenzierung zwischen großen Versionen, Bug-Fixes und Verbesserungen.

Was haben Sie Werke am besten für Sie gefunden?

Answer 1

Wenn Ihr Zweck der Dokumentation der Code, um sicherzustellen, ist in einer wiederholbaren Weise eingesetzt wird, dann wird die folgende würde die empfohlene Mindest Praxis sein:

1. Eine Zusammenfassung dessen, was über die Freigabe ist, was sich verändert, Version, wo die Lösung Datei etc gefunden werden kann.
2. Liste mögliche Abhängigkeiten
3. Detaillierte Bereitstellungsverfahren
4. Datenbankänderungen oder Skripte, die für die Installation
5. Konfiguration Zusammenfassung auf, wie die Anwendung konfiguriert ist.
6. Key Funktionsprüfung, die ausgeführt werden kann, um die als Betrieb überprüfen installieren.
7. Zurücksetzen Verfahren -. Falls erforderlich

Answer 2

Ich habe festgestellt, dass ein Werkzeug bauen, die für eine Klick-Bereitstellung ermöglicht es ist viel besser als gründliche Einsatz-Dokumentation.

Answer 3

Was ist der Zweck Ihrer Dokumentation? Von dort starten und herauszufinden, was dieses Ziel erfüllt.

Für uns ist es unser Ziel war jemand ganz neu in der Gruppe ermöglichen zu können, eine neue oder aktualisierte Bereitstellung für ein paar verschiedene Systeme auszuführen. Wir wir eine Suppe zu Nüsse Art von Betrieb Betrieb -. Windows-Dienste, Cronjobs, Datenbank-Backups, Website-Updates, etc.

In jedem Fall ist der Detailgrad wurde auf dem System basiert und was für ein neues Teammitglied müßte Updates und neue Installationen auszuführen.