☰

Ich bin dabei, eine Site-Bibel bzw. eine Dokumentation unseres Webservers zu erstellen.

tag-icon • tag-icon sql-server iis-7 web-server coldfusion documentation
Ich bin dabei, eine Site-Bibel bzw. eine Dokumentation unseres Webservers zu erstellen.

Ich erstelle dies in MS Word, um einen 3-Ring-Ordner mit Registerkarten zu erstellen, voll mit der Dokumentation aller Details zu unserem Webserver.

Welche Hauptkategorien sollte ich einschließen?

Wir haben 2 Server, beide Windows, 1 für das Web, 1 für den SQL Server, auf dem Web 1 laufen IIS7 und ColdFusion.

Ich habe keine Ausbildung als Systemadministrator, nur Dinge, die ich gelernt habe. Ich hätte zum Beispiel lieber mehr Informationen als gar keine, wie zum Beispiel, als wir gerade unsere Server migriert haben und uns eine Menge Dinge entgangen sind, weil es keine Dokumentation gab.

Ich möchte also gründliche Arbeit leisten? Als Wiki hätte ich nichts dagegen, aber mein Chef und meine Kollegen sind mit Wikis und ihrer Verwendung nicht sehr vertraut. Ich bin in unserer Gruppe eher der Penner, der alle i-Tüpfelchen setzen und alles dokumentieren möchte.

Irgendwelche Vorschläge?

Antwort1

Was Sie einschließen, hängt in gewissem Maße davon ab,WHOSie dokumentieren für. Dokumentieren Sie für Administratoren? Für Benutzer? Für Programmierer? Für alle oben genannten? Genau wie beim Entwerfen einer Site müssen Sie sich die Anwendungsfälle ansehen und sie lösen.

Dinge, die ich bei der Dokumentation, die mir als Programmierer und/oder Systemadministrator zur Verfügung gestellt wird, für wichtig halte:

  • wie Backups erstellt werden
  • wie Backups wiederhergestellt werden sollen
  • wie man die Site von Grund auf einrichtet (erforderliche Software, Installationsprozess, Konfiguration usw.)
  • Liste der Abhängigkeiten (benötigt CF, SQL Server, wird von x benötigt)
  • Dokumentation aller verwendeten APIs
  • Originalbedarfsdokumente, Änderungsdokumente (sofern vorhanden)
  • Informationen zur Erstellung/Verwendung von Administrations
  • Verfahren zum Ändern des Zugriffs bei Ausscheiden eines Benutzers (Benutzerzugriff widerrufen, gemeinsam genutzte Passwörter ändern usw.)
  • alle benutzer-/kunden-/prozessspezifischen Anpassungen
  • alle „Ertappt“-Szenarien
  • alle vorhandenen Dokumentationen für Benutzer
  • Geplante Aufgaben und deren Zeitpläne
  • Prozesse, die im Rahmen der Wartung regelmäßig ausgeführt werden müssen (Indexaktualisierungen, Defragmentierung usw.)

Wenn Sie eine elektronische Quelle wie ein Wiki erstellen, wäre Folgendes hilfreich:

  • Originalkompositionen und Mockups
  • Bildquellen
  • Flash-FLA-Dateien
  • Links von der bestehenden Site zu Anforderungen/Änderungsdokumenten
  • eine aktuelle Kopie des Release-Codes, wobei Datum/Version/usw. mit jeder Hauptversion oder nach einem Zeitplan (z. B. monatlich) aktualisiert werden.

Antwort2

Nutzen Sie OneNote für Ihre Dokumentation statt Word

  • Mehrere Benutzer können es gleichzeitig verwenden
  • Auf Wunsch als PDF exportieren
  • Die Rechtsklickfunktion „An OneNote senden“ hat den Wert unserer Dokumentation erhöht.
  • Bearbeitungen verfolgen

Dies sind nur einige der Funktionen. Für uns gibt es eigentlich zu viele Vorteile, um sie alle aufzulisten.

verwandte Informationen