Ein Erfolgsfaktor für gute Dokumentation ist eine strukturierte und systematische Herangehensweise. Dieser Beitrag vermittelt Grundlagenwissen darüber, wer was und wie dokumentieren sollte und wie man dabei den roten Faden nicht verliert.

Worauf sollte man beim Dokumentieren besonders achten? Wie integriert man Dokumentation am besten in seine Prozesse? Welche Tools bieten sich an? Wie sehr sollte man ins Detail gehen? Das geben Doku-Experten von Suse und Owncloud hier zum Besten.

Auf der DELUG-DVD finden Sie diesmal Debian 12 "Bookworm", 40 Vorträge von den Chemnitzer Linux-Tagen 2023, vier Dokumentationshelfer, OCIS 3, Memtest86+ und vieles andere mehr.

Viel Wissen im Unternehmen ist versteckt, lauert bestenfalls unter der Oberfläche. Um wertlose Silos zu vermeiden, müssen Firmen im Alltag Wissen sichern, erzeugen, teilen, managen und vermehren, ohne sich zu verzetteln.

Selbsttätige Stil- und Rechtschreibprüfung für Texte der technischen Dokumentation – das bietet Vale, ein Kommandozeilenwerkzeug, das sich gut in eine CI/CD-Pipeline oder andere automatisierte Workflows einbinden lässt.

Googles Open-Source-Sparte hat die Season of Docs 2021 gestartet. Die Aktion unterstützt Open-Source-Projekte finanziell bei der Erstellung einer Dokumentation.

Das Linux-Kernel-Team hat sich darauf geeinigt, für einige rassistisch vorbelastete und ungenaue Begriffe aus der Kernelentwicklung künftig neutralere Vokabeln zu verwenden. Begründet wird die Änderung auch mit technischen Argumenten.

Github startet eine zentrale Stelle für die Dokumentation über das hauseigene System zur Quellcodeverwaltung. Github-Entwickler finden künftig unter "docs.github.com" Hilfe.