Top-Themen

Aktuelle Themen (A bis Z)

Administrator.de FeedbackApache ServerAppleAssemblerAudioAusbildungAuslandBackupBasicBatch & ShellBenchmarksBibliotheken & ToolkitsBlogsCloud-DiensteClusterCMSCPU, RAM, MainboardsCSSC und C++DatenbankenDatenschutzDebianDigitiales FernsehenDNSDrucker und ScannerDSL, VDSLE-BooksE-BusinessE-MailEntwicklungErkennung und -AbwehrExchange ServerFestplatten, SSD, RaidFirewallFlatratesGoogle AndroidGrafikGrafikkarten & MonitoreGroupwareHardwareHosting & HousingHTMLHumor (lol)Hyper-VIconsIDE & EditorenInformationsdiensteInstallationInstant MessagingInternetInternet DomäneniOSISDN & AnaloganschlüsseiTunesJavaJavaScriptKiXtartKVMLAN, WAN, WirelessLinuxLinux DesktopLinux NetzwerkLinux ToolsLinux UserverwaltungLizenzierungMac OS XMicrosoftMicrosoft OfficeMikroTik RouterOSMonitoringMultimediaMultimedia & ZubehörNetzwerkeNetzwerkgrundlagenNetzwerkmanagementNetzwerkprotokolleNotebook & ZubehörNovell NetwareOff TopicOpenOffice, LibreOfficeOutlook & MailPapierkorbPascal und DelphiPeripheriegerätePerlPHPPythonRechtliche FragenRedHat, CentOS, FedoraRouter & RoutingSambaSAN, NAS, DASSchriftartenSchulung & TrainingSEOServerServer-HardwareSicherheitSicherheits-ToolsSicherheitsgrundlagenSolarisSonstige SystemeSoziale NetzwerkeSpeicherkartenStudentenjobs & PraktikumSuche ProjektpartnerSuseSwitche und HubsTipps & TricksTK-Netze & GeräteUbuntuUMTS, EDGE & GPRSUtilitiesVB for ApplicationsVerschlüsselung & ZertifikateVideo & StreamingViren und TrojanerVirtualisierungVisual StudioVmwareVoice over IPWebbrowserWebentwicklungWeiterbildungWindows 7Windows 8Windows 10Windows InstallationWindows MobileWindows NetzwerkWindows ServerWindows SystemdateienWindows ToolsWindows UpdateWindows UserverwaltungWindows VistaWindows XPXenserverXMLZusammenarbeit

Dokumentation richtig aufbauen - aber wie?

Frage Microsoft Windows Server

Mitglied: jgeorg

jgeorg (Level 1) - Jetzt verbinden

26.11.2008, aktualisiert 02.12.2008, 13636 Aufrufe, 5 Kommentare

Hallo,

ich suche Infos und Tipps, wie eine Dokumentation zu einer Serverinstallation zzgl. weiterer Appinstallationen korrekt erstellt wird. Was muss rein, was kann rein. Macht man das mit Word oder mit Wiki (mein Favorit) oder braucht es doch ein DMS ? Für Tipps und Verweise auf Produkte (am liebsten OpenSource) wäre ich sehr dankbar.

Gruß

Jens
Mitglied: brammer
26.11.2008 um 21:09 Uhr
Hallo,

ob du das mit Word oder einem Wiki oder einem DMS aufbaust ist eigentlich ziemlich egal
Wichtig ist erstmal das du dir ein Konzept machst was du dokumentieren möchtest und für wen du die Doku machst!
Wenn es darum geht in drei Jahren noch zu wissen reicht ein Detaillierter Überblick der Installierten Software und der Vorgenommenen Einstellungen für jedes Programm, oder willst du ermöglichen das in deiner Abwesenheit (Krankheit oder Urlaub) ein Kollege oder Ersatzmann in der Lage sein soll, ein typischer Weise gerade dann eintretendes, Desaster zu beheben?
Wenn der zweite Fall eher der Sinn deiner Übung ist, solltest du eine Schritt für Schritt Anleitung mit Screenshots und Visiozeichnungen (o.ä.) und genauer Beschreibung jeder Einstellung vornehmen und diese vor allem immer (!) aktuell halten.
Es gibt nicht Bescheideneres als veraltete Dokus und falsche Passwörter (wobei nicht alle Passwörter in die Doku gehören, sondern eine Verweis in welchem Safe die Paswörter liegen und wer Zugang dazu hat.)
Egal ob du dich für Word oder Wiki entscheidest, sorge dafür das es mindestens eine Version auf CD oder einem entfernten Rechner gelagert ist UND eine gedruckte Version, denn typischer Weise geht die Festplatte auf der die Doku liegt als erste über den Jordan.

brammer
Bitte warten ..
Mitglied: stxinden
01.12.2008 um 10:18 Uhr
Hallo Jens,

ich nutze zur Dokumentation in der Regel ein WIKI (http://www.dokuwiki.org/dokuwiki) doch ich kann Dir nur raten auch eine "offline-Version" anzulegen. Man lernt Papier echt zu schätzen .

Der Vorteil bei DokuWiki liegt in der schnellen Installation, den verfügbaren Plug-Ins und auch in der textbasierten Dateiablage, so dass keine Datenbank benötigt wird. Es kann also schnell kopiert und gesichert werden.

Was den Aufbau von Dokumentation angeht, so bin ich seit Jahr und Tag ein Freund von Screenshots, denn dann hat man direkt einen visuellen Überblick. Das macht die Sache meiner Meinung nach einfacher. Auch schön sind zum Beispiel Videos, der Aufwand ist aber ungleich höher.

Auch Visio bietet sich für die Dokumentation der Prozesse an. Ein Flussdiagramm und eine entsprechende Checkliste sind immer super.

Gruß
STX
Bitte warten ..
Mitglied: eddyedfred
01.12.2008 um 10:55 Uhr
Moin,

ich benutze auch ein Wiki zur Dokumentation. Mei Favorit ist dabei PmWiki. Hat den großen Vorteil, dass wie bei Dokuwiki keine Datenbank benötigt wird. Das Wiki kann in Verbindung mit XAMPP auf einem Stick mitgenommen werden, was die Aktualität eines Wikis doch sehr begünstigt. Das Update kann man dann immer schnell vom Stick auf den Webserver schieben.

Gruß, Marco
Bitte warten ..
Mitglied: technix
01.12.2008 um 11:59 Uhr
Hallo,
Also in den meisten Fällen ist deine Doku für den "Worst-Case".

Wenn also jemand anderes deine Tätigkeit übernimmt.
Wenn es speziell für ein Programm und/oder deren Einstellung geht solltest du recht viele Screen-shoots machen.

Falls du es nur für dich machen möchtest, reichen in den meisten Fällen nur Stichpunkte auf einen Zettel.
und dieser Zettel sollte dann in Reichweite liegen oder im Serverschrank.

Alle Dokus hängen bei uns im Racket.
desweiteren Infos über :
Patchfelder - Kabelfarben - Telefon - Switche und so weiter
Und eine für den tollen Exchange...

Grüße
Bitte warten ..
Mitglied: spacyfreak
02.12.2008 um 22:00 Uhr
Ich dokumentiere eigentlich nur noch die richtig knifflichen Dinge bei denen man ne weile basteln musste bis es lief, das macht den fachmann aus dass er knifflige dinge gelöst hat. Je mehr er davon gelöst hat desto besser wird er. Und wenn er es dokumentiert hat kann er es auch noch ein jahr später nachvollziehen was er damals gemacht hat damit was funktioniert.

jeden furz zu dokumentieren macht wenig sinn da das ausser einem selber eh kaum einer lesen wird, andere kollegen kapieren das auch meist nicht, ausser man gibt sich viel mühe - doch dazu reicht meist die zeit nicht.

Screenshots sind recht effektiv da es schnell geht. Ins Doc file rein und ablegen - und nächstes Projekt.
Bitte warten ..
Ähnliche Inhalte
Apache Server
Plesk Dokumentation über alle Dateirechte (Aufbau)
Frage von WintektivApache Server13 Kommentare

Hallo Community, ich suche vergeblich im Internet nach einer Dokumentation wie Plesk aufgebaut ist mit den Dateirechten. Hab leider ...

Utilities
Dokumentationen von Installationen?
Frage von ajonderkoUtilities2 Kommentare

Hallo zusammen, ich bin auf der Suche nach einem Tool, dass sich gut für die Dokumentation von Benutzernamen, Passwörtern, ...

Sicherheitsgrundlagen
Dokumentation von Berechtigungen
Frage von hf1965Sicherheitsgrundlagen3 Kommentare

Hallo, wer kennt das nicht, Chef ruft an und sagt: geben Sie Frau Müller mal das xyz-Programm. (Wir bekommen ...

Windows Tools
Dokumentation - Verschlüsselung
gelöst Frage von Xaero1982Windows Tools10 Kommentare

Hallo Zusammen, ich wollte eine kleine Kundendokumentation erstellen in der ich alle Informationen zum Kunden sichere, wie z.B. IP ...

Neue Wissensbeiträge
Apple

IOS 11.2.1 stopft HomeKit-Remote-Lücke

Tipp von BassFishFox vor 17 StundenApple

Das Update für iPhone, iPad und Apple TV soll die Fernsteuerung von Smart-Home-Geräten wieder in vollem Umfang ermöglichen. Apple ...

Windows 10

Windows 10 v1709 EN murkst bei den Regionseinstellungen

Tipp von DerWoWusste vor 22 StundenWindows 10

Dieser kurze Tipp richtet sich an den kleinen Personenkreis, der Win10 v1709 EN-US frisch installiert und dabei die englische ...

Webbrowser

Kein Ton bei Firefox Quantum über RDP

Tipp von Moddry vor 22 StundenWebbrowser

Hallo Kollegen! Hatte das Problem, dass der neue Firefox bei mir auf der Kiste keinen Ton hat, wenn ich ...

Internet

EU-DSGVO: WHOIS soll weniger Informationen liefern

Information von sabines vor 1 TagInternet4 Kommentare

Wegen der europäische Datenschutzgrundverordnung stehen die Prozesse um die Registrierung von Domains auf dem Prüfstand. Sollte die Forderungen umgesetzt ...

Heiß diskutierte Inhalte
Windows Server
RODC kann nicht aus Domäne entfernt werden
Frage von NilsvLehnWindows Server18 Kommentare

HAllo, ich arbeite in einem Universitätsnetzwerk mit 3 Standorten. Die Standorte haben alle ein ESXi Cluster und auf diesen ...

Hardware
Links klick bei Maus funktioniert nicht
gelöst Frage von Pablu23Hardware16 Kommentare

Hallo erstmal. Ich habe ein Problem mit meiner relativ alten maus jedoch denke ich nicht das es an der ...

Windows XP
Windows XP Aktivieren geht nicht
Frage von tetikmiroWindows XP13 Kommentare

Hallo Ich habe einen Windows XP mit einen vCenter Converter umgezogen auf eine ESXI. Soweit funktioniert dies auch ohne ...

Netzwerkmanagement
Mehrere Netzwerkadapter in einem PC zu einem Switch zusammenfügen
gelöst Frage von prodriveNetzwerkmanagement12 Kommentare

Hallo zusammen Vorweg, ich konnte schon einige IT-Probleme mit Hilfe dieses Forums lösen. Wirklich klasse hier! Doch für das ...