Skip to main content

SW-Package für Doc-as-Code Ansatz

SW-Streckbrief zu Client-Software-Package für Doc-as-Code-Ansatz


image-20220909071815093

„Wer immer tut, was er schon kann, bleibt immer das, was er schon ist.“

Informationssystem-Steckbrief

AttributBeschreibung
IS-TitelSW-Package Doc-as-Code
IS-IDSWP-DOC
ZweckDieses SW-Packet dient, ...
für die Erstellung, Verwaltung und Produktion technische Dokumentation nach dem Doc-as-Code Ansatz in verteilten Teams.
BeschreibungDie SW-Packet werden auf PC-Clients installiert. Die Publizierung der technische Dokumentation erfolgt idR. auf Webservern.
Linkkeiner
ReferenzenVersionsverwaltungssoftware für Clients (GIT, Github-Desktop)
Markdown -Editor (MS Visual Studio Code, Typora )
statischen Website -Generator (Docusaurus, Jekyll, Hugo,Gridsome)
inhaltliche ZuständigkeitAnwender
ApplikationsbetreuerIT-Serviceowner für Digital Workplaces
ZielgruppeDOC-Autoren
DOC-Reviewer
DOC-Approver
DOC-Manager
vordefinierte Berechtigungsrollenkeine
Anforderungeneinfache Anwendung für das Dokumentationsteam.
Hohe Transparenzu durch integrietes Versionsmanagement
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.