Dokumentieren einer erstellten Seite - Best Practices

    Hallo.

    Möglicherweise können ein paar erfahrene Designer/Developer mit ein paar Hinweise geben, wie eine erstellte Seite bestmöglich dokumentiert wird.

    Ich denke hier bspw. an Nutzer (Admins, Autoren, etc), email-Adressen für allgemeines, Datenschutz, etc.

    Server-Verzeichnisse, Domaininhaber, vergbene email-Adressen, Datenbanken, Verknüpfungen zu anderen Diensten (bspw. Matomo, Cookie-Consent), etc, etc - bestimmt vieles, was ich an dieser Stelle noch nicht bedacht habe.

    Ich bräuchte einmal einen Hinweis in die "richtige Richtung".

    Danke euch.

    • Gerade eben
    • Anzeige

    Hallo!

    Wenn du gerade an deiner Website arbeitest oder dein aktuelles Hosting überdenkst: Wir betreiben mit NetzLiving eine Hosting-Plattform, die speziell auf Performance, Sicherheit und einfache Verwaltung ausgelegt ist.

    • ✔️ Schnelle Ladezeiten (optimiert für WordPress & Co.)
    • ✔️ Deutsche Server & DSGVO-konform
    • ✔️ Persönlicher Support (kein 0815-Ticket-System)

    Mehr erfahren

    Ich würde erstmal hinterfragen wem so eine Dokumentation helfen soll - also wer sie nutzen soll. Denn abhängig davon entscheidet sich auch der Inhalt und die Art der Ausarbeitung.

    Zugangsdaten gehören btw. in keine Dokumentation. Ich verstehe unter Dokumentation eine Beschreibung dessen was ein Projekt umfasst (was bei einem Auftraggeber schon in Form des Auftrags vorliegen sollte) sowie die Beschreibung von Schrittfolgen wie welche Funktion zu nutzen ist. Wenn dieses Vorgehen nicht vom Wordpress-Standard abweicht, kann man darauf auch verzichten es sei denn der Auftraggeber besteht darauf.

    Ich habe so etwas früher öfter gemacht, seit einigen Jahren inzwischen gar nicht mehr.

    Danke für die Info. Ich arbeite an einer privaten Seite (zweisprachig) über Multisite-Erweiterung, werde möglicherweise eine Dritte Seite anhängen, und frage mich, wie ich für mich privat die Übersicht am besten behalte/dokumentiere.

    Ja :) Daher suche ich Tipps und Infos, wie es andere handhaben. Aus denen kann ich mir dann die für mich passende Vorgehensweise "schnüren".

    Zitat von BastiED

    Ja :) Daher suche ich Tipps und Infos, wie es andere handhaben. Aus denen kann ich mir dann die für mich passende Vorgehensweise "schnüren".

    Doxygen - es geht nichts über Doxygen... und dann gibt es da noch ein paar Unternehmen, die auch mit der Dokumentation Probleme hatten. Facebook hat für die Dokumentation ein Open-Source-Projekt geartete.... Im Team mag ich Docutils.

    in der Entwurfsphase bevorzuge ich Skizzenrollen https://www.boesner.com/zeichenpapierrolle-10326

    Mit offenen Augen träumen

Jetzt mitmachen!

Sie haben noch kein Benutzerkonto auf unserer Seite? Registrieren Sie sich kostenlos und nehmen Sie an unserer Community teil!

Benutzerkonto erstellen Anmelden