doku-regeln

Sammlung, Links, Regelwerke und Netiuetten »


Dokumentationsrichtlinien

Die Dokumentation erhöht durch Transparenz die personelle Unabhängigkeit und damit die Wartungs- und Ausfallsicherheit. Nachrücker oder Vertretungen können sich schnell und unkompliziert einarbeiten, auf Sachverhalte schnell reagieren und zu einer Lösung beitragen.

Allgemeine Leitsätze

  • Wir beschränken uns auf das Wesentliche und Notwendige.
  • Redundanzfreie Ablage - jede Information nur einmal und an einem Ort.
  • Wir pflegen von Anfang an ein Glossar.
  • Niemals Passwörter oder Zugangsdaten in der Dokumentation notieren!
  • Persönliche Daten nur mit ausdrücklichem Einverständnis der Personen

Anleitung

  • Dokumentation aufrufen
  • In Doku Eintrag suchen. Gibt es schon einen Eintrag zu meinem Thema: Inhaltsverzeichnis, Letzte Änderungen, Suche (Die Suche befindet sich oben)
  • Neuer Eintrag (Händisch eine Vorlage “kopieren”…) …und einfügen…
  • Jetzt Eintrag erstellen. Anhand der Vorlage und den dort vorgeschlagenen Feldern arbeiten
  • Nach ganz unten gehen und auf “speichern” klicken. Vorher bitte in zwei, drei Stichwörtern etwas in “Zusammenfassung” schreiben. (Bei der späteren Suche und Zuordnung von Einträgen ist dies sehr hilfreich) Wikis speichern nicht automatisch!
  • Bestehenden Eintrag bearbeiten: Wie oben beschrieben den Eintrag finden. Ggf. vorher “Suchen”

Auf bereits bestehende Einträge “verlinken” Anleitung


Glossar. Fachbegriffe und missverständliche Begriffe bitte im Glossar einpflegen und/oder darauf verlinken. Hierfür sind "Anker" wichtig, damit man direkt auf diesen Begriff verlinken kann.


Es herrscht Fluktuation bei der technischen Betreuung im Bündnis Grundeinkommen, so z.B. bei der Homepage, der E-Mail-Verwaltung und anderem. In einigen Fällen sind bisher nur ein bis zwei Leute mit der Betreuung und dem technischen Stand vertraut, so dass es bei Krankheit, Urlaub oder anderen Gründen schnell zu Engpässen kommen kann, sollten Ungereimtheiten oder Fehlfunktionen auftreten. Eine gewissenhafte, einheitliche und nachvollziehbare Dokumentation an einem zentralen Ort schafft Abhilfe.

Alle Personen, die Veränderungen vornehmen, egal ob Aktualisierung der Software, Einbinden einer Erweiterung, Konfigurationsänderungen usw. Somit folgen den Dokumentationsrichtlinien ohne Ausnahme verbindlich alle Administratoren.


Das Glossar ist ein wichtiger Teil und sollte aktiv gepflegt werden. Darum ist es wichtig, bereits in der Analyse einer fachlichen Anforderung die wichtigsten Begriffe zu identifizieren und sofort im Glossar zu erfassen. In den Reviews achten wir unter anderem auf die konsequente Nutzung dieser besonderen Worte, als "Anker", aus dem Glossar in Texten.

Bei Erstellung neuer Texte empfehlen wir, die Begriffe konsequent als "Anker" mit dem Glossar zu verlinken. Die Vorteile dieser Praxis sind:

  • Durch den Link wird der Begriff automatisch hervorgehoben
  • Der Leser kann sich durch Klick auf den Link* sofort den Begriff erklären lassen
  • Es gibt die Möglichkeit, alle Seiten zu suchen, die exakt diesen Begriff enthalten
Cookies helfen bei der Bereitstellung von Inhalten. Diese Website verwendet Cookies. Mit der Nutzung der Website erklären Sie sich damit einverstanden, dass Cookies auf Ihrem Computer gespeichert werden. Außerdem bestätigen Sie, dass Sie unsere Datenschutzerklärung gelesen und verstanden haben. Wenn Sie nicht einverstanden sind, verlassen Sie die Website. Weitere Information
  • doku-regeln.txt
  • Zuletzt geändert: 2020/02/16 10:27
  • von thomas