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…
DITA mit Eclipse, oXygen und SVN auf dem Mac
Eine leistungsfähige Entwicklungsumgebung für die Erstellung von Verwaltung von DITA-Dokumenten ist die Kombination aus Eclipse, oXygen Editor (als Eclipse-Plugin und stand-alone Version verfügbar) und SVN. Das alles gibt es auch für den Mac – es muss nur passend zusammengefügt werden.
Blue Horizon – Mit der Blockchain Flugzeugen auf der Spur
Blockchain, IoT und Raspberry Pi – das sind nur einige der elektrisierenden Buzz-Words, die auch mich zunehmend begeistern. Als ich dann in dem Buch Ethereum (Autor: Henning Diedrich) von dem Open Source Projekt Blue Horizon las, fand ich, dass es endlich an der Zeit war, meinen vernachlässigten Raspberry Pi wieder…
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.
Desktop oder mobil: die Zielgruppen machen den Unterschied
Inzwischen werden Websites mehr von mobilen Geräten besucht als vom Desktop aus – zumindest weltweit. Hierzulande überwiegt aber nach wie vor der Zugriff über den Desktop. Ob die mobile Website oder die Desktop-Website besucht wird, hängt jedoch nicht nur vom Gerät des Besuchers ab, sondern auch zu welcher Zielgruppe er…
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…
Responsive Websites – trotz TYPO3
Kleine aber feine TYPO3-Projekte wurden in diesem Jahr realisiert. Alle standen sie im Zeichen des Responsive Webdesign. Ob Neuerstellung oder der Relaunch als Responsive Website, alle sollen sie auf dem Smartphone schick aussehen. Auch wenn TYPO3 ein ausgefeiltes Template-System vermissen lässt, wie es beispielsweise bei WordPress oder Drupal zu finden…
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…