Skip to main content

SW HTML-Site Generatoren - Docusaurus

SW-Streckbrief zu Client-Software zur Produktion der Dokumentation nach dem Doc-as-Code-Ansatz


image-20220906125655788

Verbringe die Zeit nicht mit der Suche nach einem Hindernis – vielleicht ist keines da.” Franz Kafka, deutscher Schriftsteller

Informationssystem-Steckbrief

AttributBeschreibung
IS-TitelSW Static Site Generation
auch Website-Generator genannt.
IS-IDIS-SSG
ZweckDieser 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.
BeschreibungDer IT-Service ist ein geschlossenes Informationssystem zur Produktion des Contents im gewünschten Format.
LinkDOC-Workbench (über SSH im Firmennetz erreichbar)
ReferenzenDocusaurus - statischer Website Generator für technische Dokumentationen.
Docsify - zum Testen der Markdown-Strukturen auf dem lokalen Rechner
HUGO
Jekyll
Gridsome
inhaltliche ZuständigkeitVerantwortlich 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.
ApplikationsbetreuerIT
ZielgruppeDOC-Autoren
DOC-Reviewer
DOC-Approver
DOC-Manager
vordefinierte BerechtigungsrollenDOC-Production-Administrator = Verwalter des Portals. Kann neue Mitglieder einladen.
DOC-Production-Members = hat Schreibrechte und kann "Content" hinzufügen.
DOC-Production-Guest = nur Leseberechtigung
Anforderungeneinfache Anwendung für Prozessmitglieder.
Verweisekeine

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.