SW-Package für Doc-as-Code Ansatz
SW-Streckbrief zu Client-Software-Package für Doc-as-Code-Ansatz
„Wer immer tut, was er schon kann, bleibt immer das, was er schon ist.“
Informationssystem-Steckbrief
| Attribut | Beschreibung |
|---|---|
| IS-Titel | **SW-Package Doc-as-Code ** |
| IS-ID | SWP-DOC |
| Zweck | Dieses SW-Packet dient, ... für die Erstellung, Verwaltung und Produktion technische Dokumentation nach dem Doc-as-Code Ansatz in verteilten Teams. |
| Beschreibung | Die SW-Packet werden auf PC-Clients installiert. Die Publizierung der technische Dokumentation erfolgt idR. auf Webservern. |
| Link | keiner |
| Referenzen | Versionsverwaltungssoftware für Clients (GIT, Github-Desktop) Markdown -Editor (MS Visual Studio Code, Typora ) statischen Website -Generator (Docusaurus, Jekyll, Hugo,Gridsome) |
| inhaltliche Zuständigkeit | Anwender |
| Applikationsbetreuer | IT-Serviceowner für Digital Workplaces |
| Zielgruppe | DOC-Autoren DOC-Reviewer DOC-Approver DOC-Manager |
| vordefinierte Berechtigungsrollen | keine |
| Anforderungen | einfache Anwendung für das Dokumentationsteam. Hohe Transparenzu durch integrietes Versionsmanagement |
| 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.