6
Online Dokumentation erstellen
Hallo! Ich soll für eine Software eine Online-Dokumentation erstellen, damit diese auch Kunden bequem nutzen können.
Es gibt also schon ein Handbuch als .pdf und eine FAQ usw., allerdings recht veraltet.
Das soll nun alles schön vereinheitlicht und modernisiert werden.
Leider habe ich keine html/css Erfahrung, muss also auf sowas wie Website Builder oder ähnliche Services zurückgreifen (es soll sowieso wysiwyg sein).
Es soll also kein überflüssiger Schnickschnack vorhanden sein. Nur modern, übersichtlich und komfortabel.
Wie z.B. die Hilfe bei google: https://support.google.com/docs oder https://help.helpjuice.com/
D.h. links oder rechts eine aufklappbare Navi-Bar und ein schönes, simples Design.
AutoTranslate und pdf-Export einzelner Seiten (oder von allem) ist ebenfalls wünschenswert.
Dann Bilder/ Videos implementieren und das wars dann auch eigentlich schon. Wenn das Ganze natürlich immer größer werden kann, ist das natürlich auch okay.
ProProfs, helpjuice, http://www.doctohelp.com/ etc. ist sicher alles sehr gut, aber für meine Belange zu teuer und auch zu umfangreich für den Zweck.
Ich habe bereits über manula.com einen Anfang gemacht und das funktioniert ganz gut. Aber so richtig zufrieden bin ich mit den Anpassungsmöglichkeiten und dem Design nicht.
D.h. so etwas wie manula.com, bloß ggf. etwas umfangreicher.
Ein Wiki eignet sich meiner Meinung als Handbuch/FAQ nicht so wirklich.
Über wordpress, wix, jimdo etc. lässt sich sowas sicher auch realisieren, aber ich muss eben keine komplett neue Website erstellen, sondern nur eine Help Database/ Online Manual.
Oder gäbe es da einen guten offline wysiwyg Editor?
Auf unseren WebServer kann die Seite natürlich dann hochgeladen werden.
Ich bedanke mich schonmal für Vorschläge!
Es gibt also schon ein Handbuch als .pdf und eine FAQ usw., allerdings recht veraltet.
Das soll nun alles schön vereinheitlicht und modernisiert werden.
Leider habe ich keine html/css Erfahrung, muss also auf sowas wie Website Builder oder ähnliche Services zurückgreifen (es soll sowieso wysiwyg sein).
Es soll also kein überflüssiger Schnickschnack vorhanden sein. Nur modern, übersichtlich und komfortabel.
Wie z.B. die Hilfe bei google: https://support.google.com/docs oder https://help.helpjuice.com/
D.h. links oder rechts eine aufklappbare Navi-Bar und ein schönes, simples Design.
AutoTranslate und pdf-Export einzelner Seiten (oder von allem) ist ebenfalls wünschenswert.
Dann Bilder/ Videos implementieren und das wars dann auch eigentlich schon. Wenn das Ganze natürlich immer größer werden kann, ist das natürlich auch okay.
ProProfs, helpjuice, http://www.doctohelp.com/ etc. ist sicher alles sehr gut, aber für meine Belange zu teuer und auch zu umfangreich für den Zweck.
Ich habe bereits über manula.com einen Anfang gemacht und das funktioniert ganz gut. Aber so richtig zufrieden bin ich mit den Anpassungsmöglichkeiten und dem Design nicht.
D.h. so etwas wie manula.com, bloß ggf. etwas umfangreicher.
Ein Wiki eignet sich meiner Meinung als Handbuch/FAQ nicht so wirklich.
Über wordpress, wix, jimdo etc. lässt sich sowas sicher auch realisieren, aber ich muss eben keine komplett neue Website erstellen, sondern nur eine Help Database/ Online Manual.
Oder gäbe es da einen guten offline wysiwyg Editor?
Auf unseren WebServer kann die Seite natürlich dann hochgeladen werden.
Ich bedanke mich schonmal für Vorschläge!
Auf Facebook teilen
Auf Twitter teilen
Auf Reddit teilen
Auf Linkedin teilenBitte markiere auch die Kommentare, die zur Lösung des Beitrags beigetragen haben
Content-ID: 332234
Url: https://administrator.de/contentid/332234
Ausgedruckt am: 19.11.2024 um 09:11 Uhr
6 Kommentare
Neuester Kommentar
Moin,
meine Empfehlung für Software doku: https://readthedocs.org
Bietet alles was man braucht. Idealerweise nutzt du reStructuredText statt Markdown, aus diversen Gründen.
Ja, es ist keine WYSIWYG-Editor-Empfehlung, aber es ist nun mal state-of-the-art genau sowas nicht mehr zu verwenden. Und das hat gute Gründe: WYSIWYG war nämlich noch nie WYSIWYG. Es gibt immer Unterschiede, Probleme und Unschönheiten.
Gründe warum man Dokus eben in anderen Formaten wie unter anderem auch LaTeX schreibt und nicht in Word. (Zumindest wenn man sowas wirklich mit wenig Wartungsaufwand und seriös macht)
Ob du deine Doku letztlich bei readthedocs hostest oder selbst durch sphinx jagst, ist letztlich dir überlassen.
Soweit zumindest meine Tips
Gruß
Chris
meine Empfehlung für Software doku: https://readthedocs.org
Bietet alles was man braucht. Idealerweise nutzt du reStructuredText statt Markdown, aus diversen Gründen.
Ja, es ist keine WYSIWYG-Editor-Empfehlung, aber es ist nun mal state-of-the-art genau sowas nicht mehr zu verwenden. Und das hat gute Gründe: WYSIWYG war nämlich noch nie WYSIWYG. Es gibt immer Unterschiede, Probleme und Unschönheiten.
Gründe warum man Dokus eben in anderen Formaten wie unter anderem auch LaTeX schreibt und nicht in Word. (Zumindest wenn man sowas wirklich mit wenig Wartungsaufwand und seriös macht)
Ob du deine Doku letztlich bei readthedocs hostest oder selbst durch sphinx jagst, ist letztlich dir überlassen.
Soweit zumindest meine Tips
Gruß
Chris
Ich würde Gitbook.com empfehlen
1
Danke, schaue ich mir mal an!
Also bei gitbook sehe ich keine Möglichkeiten zur Anpassung an ein Corporate Design (also eigene Farbe etc.).
Es geht hier wie gesagt nicht um interne Entwicklungsdokumentation.
Es geht um die Präsentation nach außen, für DAUs verständlich, intuitiv, mit Bild und Videounterstützung etc.
Kein sterile Seite, in der ein Dev seinen neuen Code vorstellt.
Es geht hier wie gesagt nicht um interne Entwicklungsdokumentation.
Es geht um die Präsentation nach außen, für DAUs verständlich, intuitiv, mit Bild und Videounterstützung etc.
Kein sterile Seite, in der ein Dev seinen neuen Code vorstellt.
Sorry, aber dann hast du , gelinde gesagt, nicht genau geschaut.
Themes
https://toolchain.gitbook.com/syntax/markdown.html#images Images">rel="nofollow" href="https://toolchain.gitbook.com/syntax/markdown.html#images" title="https://toolchain.gitbook.com/syntax/markdown.html#images" onclick="window.open(this.href); return false;">https://toolchain.gitbook.com/syntax/markdown.html#images Images
Plugins inklusive "Exercises"
Themes
https://toolchain.gitbook.com/syntax/markdown.html#images Images">rel="nofollow" href="https://toolchain.gitbook.com/syntax/markdown.html#images" title="https://toolchain.gitbook.com/syntax/markdown.html#images" onclick="window.open(this.href); return false;">https://toolchain.gitbook.com/syntax/markdown.html#images Images
Plugins inklusive "Exercises"
Dein Link funktioniert irgendwie nicht komplett.
Ist also eine Anpassung (Farbe etc,) nur mit vorher erstelltem CSS/HTML möglich?
Ist also eine Anpassung (Farbe etc,) nur mit vorher erstelltem CSS/HTML möglich?
