Infos und reStructuredText

Ich hatte nach einem der letzten Seminare Zeit meine Online-Dokumentationen durchzusehen und zu überarbeiten. Dabei habe ich auch entschieden auf der PCS.de ein mehr Übersicht und Farbe ins Spiel zu bringen.

Übersicht PCS.de

Die Inhalte auf dem PCS.de Portal begleiten die Trainings- und Seminar-Inhalte der letzten Jahrzehnte.

Dabei ist eine Bandbreite entstanden, der ich etwas Struktur verleihen möchte. Hierfür habe ich die technischen Darstellungen und Infos in vier Bereiche gegliedert und mit einem Farbschema kombiniert. Die Website liefert hierfür das Farbthema Nord aus. In Joomla- bzw. Online-Trainingsumgebungen kann ich das System schnell auf andere Farbthemen (Catppuccin-Frappé, Dracula) umschalten.

FITSN

Von der Hardware und Netzwerktechnik bis zu den den Betriebssystemen Windows, Windows Server und Linux.

Zertifikat FITSN

CMSOD

Praxisorientierte Webtechnik von A bis Z: aktuelle Online Techniken von der statischen Website bis zu Content Management Systemen.

Zertifikat CMSOD

ITDIV

Administrationen mit Shell unter Windows und Linux. Container und Orchestrierungen. Professionelle und Effizientes Office.

Administration und Office

TIPPS

Sammlungen von Tipps und Tricks rund um die IT - für den täglichen Windows-Nutzer bis zum Linux-Admin-Profi.

Tipps und Tricks

Und natürlich können spezielle Seminarthemen immer angefragt werden!

reStructuredText IT-Dokumentationen

Ich habe neben den Ausarbeitungen im Rahmen von Seminaren auf dieser Website diverse weitere Infos in Form von reStructuredText Dokumentationen aufbereitet.

reStructuredText Dokumente in Rubriken

Durch die Aufbereitung dieser zusätzlichen Dokumente im RST-Format können die Dokumentationen in diversen Ausgabeformaten präsentiert werden. In den folgenden Auflistungen finden sich dann sowohl die HTML-, Epub oder auch PDF-Formate, die aus denselben Grunddokumentationen heraus erstellt werden können!

In den nachfolgenden Tabellen pflege ich eine Übersicht mit Anmerkungen zu den diversen Dokumentationen.

IT Tech - Ausarbeitungen rund um IT Techniken von A bis Z
Plan: Zusammenlegungen der Dokumentationen in Zentraldokument IT Dokumentation Trainer Joe Brandes: it.joe-brandes.de 

[Status: Sep/Okt 2024]

Die Arbeiten für das Zusammenlegen der Dokumente haben im Rahmen der Herbstseminare (siehe IT-Werkstatt) begonnen. Die Website wurde mit einem neuen HTML-Template reorganisiert und fasst nun meine aktuellen rST-Dokumentation zusammen!

Webtechnik - Schwerpunkt: Content Management Systeme

Office - Bürosoftware und Technik

Die auf rohen Texten basierenden Basisdokumente können sehr effizient mit Dokumentverwaltungstools wie Git verwaltet und organisiert werden. Auch eine Collaboration mit anderen Autoren wäre über diese Techniken problem möglich.

Die verschiedenen Ausarbeitungen habe ich im Herbst 2024 auf einem gemeinsamen Info-Portal it.joe-brandes.de gebündelt/zusammengefasst. Der Einstieg zu meinen Dokument ist jetzt unter it.joe-brandes.de erreichbar.

Technikartikel Zeitschrift iX zu Dokumentationen

Zitat/Auszug aus "Softwareprojekte konsistent mit Antora dokumentieren" - 28.10.2024 10:00 Uhr Christian Heitzmann
(Link Beitrag auf iX)

Die folgende Abbildung zeigt den Zusammenhang zwischen der Flexibilität und der Komplexität ausgewählter (normaler und vereinfachter) Auszeichnungssprachen. Mit Markdown am unteren Ende (sehr beschränkter Funktionsumfang, dafür sehr einfach) und LaTeX am oberen Ende der Skala (quasi unbeschränkter Funktionsumfang, aber relativ schwerfällig) stellen sich AsciiDoc und reStructuredText als guter Kompromiss heraus.

Während AsciiDoc alle Ansprüche an eine vereinfachte Allzweckauszeichnungssprache erfüllt, ist reStructuredText eher in der Python-Welt zu Hause. reStructuredText ist als Sprache und mit seinem Standarddokumentationsgenerator Sphinx – quasi das Analogon zu Antora für AsciiDoc – schon mehr an Technikaffine gerichtet. [Super: ich bin technikaffin ;-)]

Ich wünsche viel Spaß und Erfolg bei den Umsetzungen.
Ihr Trainer Joe Brandes