Ich habe neben den Ausarbeitungen im Rahmen von Seminaren auf dieser Website diverse weitere Infos in Form von reStructuredText Dokumentationen aufbereitet.
Übersicht 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!
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.
Weitere Impressionen von it.joe-brandes.de:
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
| Seminar | Anmerkungen | Link |
|---|---|---|
| IT-Werkstatt | ehemals: PC-Werkstatt (inaktiv) -> rST online als IT-Werkstatt -> final: Hauptinhalte für IT Dokumentationen Trainer Joe Brandes | IT Dokumentationen rST |
| PowerShell | PowerShell rST | |
| Git | Git rST | |
| Linux | siehe auch: LPIC Seminare | Linux rST |
| Container | ehemals: Docker | Container rST |
| Security | Sammlung | Security rST |
| Wireshark | in Erarbeitung |
[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
| Seminar | Anmerkungen | Link |
|---|---|---|
| WordPress | WordPress rST | |
| TYPO3 | TYPO3 rST |
Office - Bürosoftware und Technik
| Seminar | Anmerkungen | Link |
|---|---|---|
| Outlook | Outlook rST | |
| Excel | Excel rST | |
| LaTeX | LaTeX rST | |
| Indesign | Indesign rST |
Technikartikel Zeitschrift iX
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
