SW HTML-Site Generatoren - Docusaurus
SW-Streckbrief zu Client-Software zur Produktion der Dokumentation nach dem Doc-as-Code-Ansatz
Verbringe die Zeit nicht mit der Suche nach einem Hindernis – vielleicht ist keines da.” Franz Kafka, deutscher Schriftsteller
Informationssystem-Steckbrief
| Attribut | Beschreibung |
|---|---|
| IS-Titel | **SW Static Site Generation ** auch Website-Generator genannt. |
| IS-ID | IS-SSG |
| Zweck | Dieser IS-Service dient, ... zur formellen Prüfung der Inhalte und Styles sowie zur Produkten des digitalen Contents im gewünschten Ausgabeformat wie etwa html für Websites, PDF-Format für Printdokumente, eBooks, etc. Dies Tools sind zur laufenden Überprüfung der Ausgabe auch für den Autor und dem Reviewer hilfreich. Muss aber nicht unbedingt auf den Client-Rechnern vorhanden sein. |
| Beschreibung | Der IT-Service ist ein geschlossenes Informationssystem zur Produktion des Contents im gewünschten Format. |
| Link | DOC-Workbench (über SSH im Firmennetz erreichbar) |
| Referenzen | Docusaurus - statischer Website Generator für technische Dokumentationen. Docsify - zum Testen der Markdown-Strukturen auf dem lokalen Rechner HUGO Jekyll Gridsome |
| inhaltliche Zuständigkeit | Verantwortlich für die Konfiguration, Bereitstellung und Führung der digitalen Plattform zur Wissenbereitstellung und -verteilung ist das Dokumentations-Team in Abstimmung mit dem jeweiligen IT-Service-Owner. |
| Applikationsbetreuer | IT |
| Zielgruppe | DOC-Autoren DOC-Reviewer DOC-Approver DOC-Manager |
| vordefinierte Berechtigungsrollen | DOC-Production-Administrator = Verwalter des Portals. Kann neue Mitglieder einladen. DOC-Production-Members = hat Schreibrechte und kann "Content" hinzufügen. DOC-Production-Guest = nur Leseberechtigung |
| Anforderungen | einfache Anwendung für Prozessmitglieder. |
| Verweise | keine |
Tabelle Informationssystem-Steckbrief
Docusaurus
Docusaurus ist ein statischer hmtl-Generator für technische Dokumentationen, Es ist im wesentlichen ein Set von npm Packages. Dem Dokumentationstea wird empfohlen dieses SW-Packete zu installieren. Damit können die Ergebnisse gleich verifiziert werden.