Dokumentations System - Selfhosted?

[Departet]

Moin!

Bei uns werden Dokumentationen aktuell nicht sehr schön geführt (immerhin werden welche geführt).
Gibt es eventuell eine Software um Dokumentationen zu erstellen und leicht zugänglich zu machen?
Aktuell haben die Mitarbeiter ihre Dokus im eigenen Ordner und man muss eine ganze Weile suchen bis man weiß wer wohl die Doku zu xy erstellt hat.
Wir haben ein paar Dokus im Wiki von Zammad angelegt. Da wir aber Zammad nicht mehr nutzen und das Wiki auch keinen schönen Editor hat wollen wir hier gerne auch mit den Dokus weg.
Generell war die Möglichkeit alle Dokus als eien Art Wiki zu haben sehr schön. Nutzt also vielleicht irgendwer eine Software um seine Dokumentationen Web-Basiert zu verwalten?

Mfg,
Departet

 

[Rossie]

Docusaurus ist recht beliebt (und kostenlos). Nutzt Markdown als Content-Format. Hier eine Seite, die damit umgesetzt wurde: https://docs.appcircle.io/. Projekt ist von Meta/Facebook.

 

[andy_0]

Ich kenne hier die typischen Bugtracker mit integrierten Wiki Systemen wie z.B. Gitea. Das erscheint für euren Bedarf aber eher nicht zu treffen (zu viel Drumherum, zu wenig Wiki Features).

Als reines Wiki würde ich Wiki.Js vorschlagen. Docusaurus klingt auch ganz gut, hab ich bislang aber noch nicht gehört. Insgesamt gibt es da draußen ganz viele Projekte die als Dokunentenwiki agieren wollen.

Zeichnet ihr Diagramme? Wenn ja: womit? Manche Systeme haben mittlerweile Integration von PlantUml oder Mermaid.

 

[Seiyaru2208]

Also der Klassiker ist da natürlich JIRA in Kombination mit Confluence.

 

[Departet]

@Rossie Dokusaurus sieht wirklich gut aus, gucken wir uns auf jeden Fall näher an!

@andy_0 Diagramme zeichnen wir nicht. Ich habe dokuwiki(?) getestet. Grundlegend ganz okay aber wieder eine eigene Syntax und kein automatisches Verzeichnis usw.

 

[andy_0]

Dokuwiki ist ziemlich altbacken.

Grundsätzlich arbeiten fast alle Systeme mit Markdown. Einige haben obendrauf Erweiterungen oder alternativen.

Wiki.js hat auf alle Fälle grafische Editoren, wobei Markdown nach ner Weile schon "ok" zu tippen ist.

Unterstützung für Mermaid oder ähnliches ist mir zunehmend wichtig, da man sonst Zeichnungen (Sequenzdiagramme, Ablaufdiagramme, ...) sonst nur umständlich als SVG / PNG hinzufügen kann.

 

[Departet]

Grundsätzlich arbeiten fast alle Systeme mit Markdown. Einige haben obendrauf Erweiterungen oder alternativen.

Würde mir auch reichen. Und die Kollegen müssen sich einfach langsam mal damit abfinden. Markdown findet man doch heutzutage eh überall.

 

[Pako1997]

Confluence/Jira ist an sich definitiv eine gute Wahl, denn es erlaubt auch grafisch mal etwas aktiver zu werden wie reines markdown. Erlaubt, denn es ist eben kein Muss und man kommt mit reinem Markdown auch klar, kann Bilder und Dokumente einbinden etc.

 

[konkretor]

https://marketplace.visualstudio.com/items?itemName=zaaack.markdown-editor

Gibt doch gute Erweiterungen, damit schreibst die Seiten ganz bequem in mark down ohne Kenntnisse darüber.

 

[Departet]

Jira + Confluenze kommt mit auf die Liste! Wird morgen alles genau inspiziert

 

[netzgestaltung]

Weils grad wo anders aufgepoppt ist, das kannte ich noch nicht: https://www.bookstackapp.com/

 

[Mordi]

https://www.bookstackapp.com/

Das nutzen wir inzwischen auf Arbeit, macht nen guten Eindruck auf mich. Kann ich weiterempfehlen

 

[Rickmer]

Bei uns kommt Screensteps zum Einsatz:
https://www.screensteps.com/

 

[Departet]

Um hier einen sauber Strich zu ziehen hier noch was es geworden ist
Wir haben zuerst WikiJS ausprobiert aber hier fehlten und diverse Features. Einige davon kommen wohl in der nächsten Version aber eben nicht alle und wir wollten auch nicht so lange warten.
Am Ende ist es dann Bookstack geworden. Die Features umfasse alles was wir gesucht haben und auch sonst klappt hier alles tippi toppi.

 

[andy_0]

Kannst du vlt. noch kurz erklären, was für Features für Bookstack aussagekräftig war?

 

[Departet]

Klar! Das sind jetzt aber nicht alles Features die NUR Bookstack hat.

• LDAP
• LDAP Group Mapping
• Ausreichendes Rechte System
• Editoren wo alle glücklich sind (WYSIWYG + MD)
• Schöne Gliederung der Docs/Bücher (looking at you jWiki)
• Generell ein sehr übersichtliches System (backend + frontend)