Wo kann ich eine Vorlage für die Dokumentation über serverseitige Installation von Software finden? [geschlossen]

Question

Ich bin auf der Suche nach einer guten Vorlage auf serverseitige Installation von Software für ein Projekt arbeite ich an.

Die Client-Seite ist ziemlich geradlinig. Die serverseitige Installation ist ein wenig komplizierter. Es besteht aus mehreren Stücken (Dienste, Datenbankverbindungen, Abhängigkeiten, Ports, die nicht blockiert werden müssen, etc.) gemacht. Während eines kürzlichen Test wurden mehrere undokumentierte Stücke entdeckt. Jetzt brauche ich Installationsdokumentation für unsere Disaster-Recovery-Pläne und Möglichkeiten zu schaffen, um die Installation zu testen, ohne notwendigerweise ein „full-up“ System zu testen, auf.

Ich würde wirklich wie ein Vorschlag, wo ich eine Vorlage oder ein wirklich gutes Beispiel für ein solches Dokument erhalten. Ich würde es gerne etwas sein, das ein Bediener könnte in der Hitze einer Erholung lesen und verstehen.

---

[EDIT] Unsere aktuelle Dokumentation stammt hauptsächlich aus den Fragen unsere Administratoren bei Off-Site-Tests haben. Als neuer Code geschrieben ist, würde ich die Dokumentation machen, wie sicher vor der Zeit geschrieben wird. Ich habe das Sammeln VMWare Bilder Test zu starten, wurde aber für einige gute Beispiele suchen. Es ist ein Windows Server-Shop (2000 & 2003). Word-Vorlagen wäre toll, aber wenn ich eine gute Dokumentation sehen konnte, konnte ich die Vorlagen erstellen. Irgendwelche Vorschläge, was sollte auch wäre toll, getestet werden.

---

[2nd EDIT] Ich habe geschrieben mehrere gute Ideen aus den Antworten bekommen. Nach dem Wechsel meiner Google-Suche, kam ich mit einem paar guten Ausgangspunkten. Sie sind nicht perfekt, aber sie sind ein guter Anfang.

Microsoft Exchange - http://technet.microsoft .com / de-de / library / bb125074 (EXCHG.65) aspx iPhone - http://manuals.info.apple.com/en_US/Enterprise_Deployment_Guide.pdf

http://www.novell.com/documentation/gwgateways/gw7_exch/index.html?page=/documentation/gwgateways/gw7_exch/data/ab32nt1.html http: //cregan.wordpress .com / 2006/06/22 / Austausch-2003-Schritt-für-Schritt-Installationsanleitung /

http://technet.microsoft.com/en-us/magazine /cc160942.aspx

Briefe Planung in der Planungsphase gut - http://www.onlamp.com/pub/a/onlamp/2004/04/08/disaster_recovery.html?page=2

---

[Bearbeiten 10/29/2008]
Dies ist die Art Probe ich suchte. Es braucht nicht eine Menge Müll haben, scheint aber genug von der warum zusammen mit dem wie http zu erklären: //wiki.alfresco.com/wiki/Installing_Labs_3_Nile

Answer 1

Was sollte getestet werden? Nun, im Fall einer Website „können Sie auf der Seite bekommen?“ Fügen Sie eine URL als Ausgangspunkt und lassen Sie den Admin zu einem bestimmten Punkt durchklicken. Es ist nicht erforderlich, dass der Administrator über den gesamten QS-Zyklus zu gehen, nur eine Bestätigung, dass, was Sie meinten eingesetzt werden soll, wirklich das, was eingesetzt wurde.

---

Andere Ideen Auch wir (mein Team bei meinem letzten Job) hatten QA die Bereitstellung testen. Als QA Person sein soll, war er mit den Details nicht intim und wie er zu QA Einsatz konnten wir Feedback bekommen, was schief gelaufen ist.

Eine andere Sache, die nützlich ist, ist mit dem Admin (e) vor dem Einsatz Hinsetzen. Fahren Sie über die Anweisungen und sicherstellen, dass sie ihnen die gleiche Art und Weise verstehen, was Sie tun.

---

Vorlage? So stellen Abschnitte, die Felder für die Daten wie URL zu DEV, QA und ART haben. Wenn Sie die Anweisung schreiben, können Sie denjenigen beziehen. es muss nur klar, was eingesetzt wird.

Answer 2

Die umfassendste Methode, die wir haben kamen mit unserer DR-Dokumentation für die Erstellung, beinhaltet einen vollen Zyklus gehen (oder zwei) der Installation, und jeden Schritt auf dem Weg zu dokumentieren.

Ich weiß, das ist ein bisschen schwierig sein kann, wenn Sie Ihre Unterlagen keinen Test (oder Ersatz) System zu verwenden, zu schaffen - aber es ist Lobbying im Wert von mindestens einmal durch diesen Zyklus läuft

.

(ich empfehle zweimal, das zweite von jemand nicht mit dem Projekt beteiligt getan -. Dies ist, wie Sie die Dokumentation für künftige Administratoren testen, die möglicherweise nicht wie bei dem Prozess erlebt werden)

Ein Nebeneffekt der oben genannten ist, dass Ihre Dokumentation ziemlich groß wird - zuletzt ich es zu tun hatte, glaube ich die fertige Installationsanleitung für unseren Datenbankserver war mehr als 30 Seiten

.

Answer 3

In Abhängigkeit von dem admins, Automatisierung ist hilfreich. Ich habe Windows-Administratoren hat, die ein Word-Dokument mit Schritt für Schritt Anleitungen und andere Admins wollen, die ein Skript wollten.

Allerdings sind einige hilfreiche Dinge zu schließen, wahrscheinlich als Abschnitte

• Datenbankänderungen
  • Scripts ausführen
  • Überprüfung, dass sie arbeiteten
• Konfigurationsänderungen
  • Was ist die Änderung
  • , wobei eine Version der neuen Datei ist (In meinem Fall, dass sie die beiden diffed, die weniger Fehler in Bezug auf produktionsspezifische Werte geholfen)
• Allgemeine Überprüfung
  • , was aus der Sicht der Nutzer (Feature Änderungen) anders sein sollte
• Für Web-Farm-Installationen, könnte es hilfreich sein, ein Koordinierungs Dokument hat darüber, wie die Server in der und aus dem Pool gezogen werden müssen.