For Google’s Season of Docs – 2020, the project „Extending and improving the ROOT documentation“ was conducted at CERN-HSF. ROOT is an object-oriented framework that provides all the functionalities needed to deal with big data processing, statistical analysis, visualization and storage in high-energy physics (The Higgs boson was found with…
Google Season of Docs 2019 – Project Report
For Google’s Season of Docs – 2019, the project „ROOT Documentation: Analyze, Restructure and Rewrite“ was conducted at CERN-HSF. ROOT is an object-oriented framework that provides all the functionalities needed to deal with big data processing, statistical analysis, visualization and storage in high-energy physics. Short description of the work done…
Über IT schreiben – wider dem Textbrei
Ratgeber gibt es schon mehr als genug – sollte man meinen – jedoch werden immer wieder welche veröffentlicht, die aus dem trögen Einerlei herausragen. Dazu gehört zweifellos auch „Weniger schlecht über IT schreiben“ von Christina Czeschik und Matthias Lindhorst. Dem Leser/potentiellen Autor* wird in diesem Buch aufgezeigt, wie er sich…
Software dokumentieren – aber richtig ?!
Wie wird Software „richtig“ dokumentiert? Diese Frage wurde mir mit einer Anfrage gestellt, in deren Kern es darum ging, die bestehende Software-Dokumentation dahingehend zu untersuchen, ob die zelebrierte „Leistungsschau der Buttons“ noch zeitgemäß sei.
Gute Dokumentation – schlechte Dokumentation
Es gibt zahlreiche Gründe, warum Technische Dokumentation schlecht sein kann: fehlender Input oder der Input kam nicht rechtzeitig, keine Standards fürs Schreiben, fehlendes oder mangelhaftes Qualitätsmanagement, nicht die passenden Tools, fehlendes Know-how im Allgemeinen usw. usf. Aber es gibt auch Ursachen für schlechte Technische Dokumentation, deren Ursprünge zunächst einmal dafür…
Der Test: Wie findet man eine/n gute/n Technische/n Redakteur/in?
Wenn ein Unternehmen eine/n gute/n Technische/n Redakteur/in sucht, besteht durchaus die Gefahr, dass nach erfolgter Auswahl die Katze im Sack gekauft wurde. Um dies zu vermeiden, haben Unternehmen die ein oder andere Methode entwickelt, um diese gefährliche Klippe zu umschiffen. Üblich ist es daher, sich Arbeitsproben vorlegen zu lassen, oder…