Top-Themen

Aktuelle Themen (A bis Z)

Administrator.de FeedbackApache ServerAppleAssemblerAudioAusbildungAuslandBackupBasicBatch & ShellBenchmarksBibliotheken & ToolkitsBlogsCloud-DiensteClusterCMSCPU, RAM, MainboardsCSSC und C++DatenbankenDatenschutzDebianDigitiales FernsehenDNSDrucker und ScannerDSL, VDSLE-BooksE-BusinessE-MailEntwicklungErkennung und -AbwehrExchange ServerFestplatten, SSD, RaidFirewallFlatratesGoogle AndroidGrafikGrafikkarten & MonitoreGroupwareHardwareHosting & HousingHTMLHumor (lol)Hyper-VIconsIDE & EditorenInformationsdiensteInstallationInstant MessagingInternetInternet DomäneniOSISDN & AnaloganschlüsseiTunesJavaJavaScriptKiXtartKVMLAN, WAN, WirelessLinuxLinux DesktopLinux NetzwerkLinux ToolsLinux UserverwaltungLizenzierungMac OS XMicrosoftMicrosoft OfficeMikroTik RouterOSMonitoringMultimediaMultimedia & ZubehörNetzwerkeNetzwerkgrundlagenNetzwerkmanagementNetzwerkprotokolleNotebook & ZubehörNovell NetwareOff TopicOpenOffice, LibreOfficeOutlook & MailPapierkorbPascal und DelphiPeripheriegerätePerlPHPPythonRechtliche FragenRedHat, CentOS, FedoraRouter & RoutingSambaSAN, NAS, DASSchriftartenSchulung & TrainingSEOServerServer-HardwareSicherheitSicherheits-ToolsSicherheitsgrundlagenSolarisSonstige SystemeSoziale NetzwerkeSpeicherkartenStudentenjobs & PraktikumSuche ProjektpartnerSuseSwitche und HubsTipps & TricksTK-Netze & GeräteUbuntuUMTS, EDGE & GPRSUtilitiesVB for ApplicationsVerschlüsselung & ZertifikateVideo & StreamingViren und TrojanerVirtualisierungVisual StudioVmwareVoice over IPWebbrowserWebentwicklungWeiterbildungWindows 7Windows 8Windows 10Windows InstallationWindows MobileWindows NetzwerkWindows ServerWindows SystemdateienWindows ToolsWindows UpdateWindows UserverwaltungWindows VistaWindows XPXenserverXMLZusammenarbeit

Online Dokumentation erstellen

Mitglied: Stoffn

Stoffn (Level 1) - Jetzt verbinden

15.03.2017 um 17:42 Uhr, 2862 Aufrufe, 6 Kommentare, 1 Danke

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!
Mitglied: Sheogorath
15.03.2017 um 19:28 Uhr
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
Bitte warten ..
Mitglied: MrTrebron
15.03.2017 um 19:57 Uhr
Ich würde Gitbook.com empfehlen
Bitte warten ..
Mitglied: Stoffn
17.03.2017 um 11:38 Uhr
Danke, schaue ich mir mal an!
Bitte warten ..
Mitglied: Stoffn
17.03.2017 um 12:54 Uhr
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.
Bitte warten ..
Mitglied: MrTrebron
19.03.2017 um 13:43 Uhr
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"
Bitte warten ..
Mitglied: Stoffn
20.03.2017 um 12:51 Uhr
Dein Link funktioniert irgendwie nicht komplett.
Ist also eine Anpassung (Farbe etc,) nur mit vorher erstelltem CSS/HTML möglich?
Bitte warten ..
Ähnliche Inhalte
Datenschutz

DSGVO + IT Dokumentation + Tätigkeits Dokumentation

Frage von LaBombaDatenschutz5 Kommentare

Hallo, mich würde einmal interessieren was bei euch so alles seit Einführung der neuen DSGVO passiert ist. Unser Chef ...

Windows Tools

Dokumentation - Verschlüsselung

gelöst Frage von Xaero1982Windows Tools10 Kommentare

Hallo Zusammen, ich wollte eine kleine Kundendokumentation erstellen in der ich alle Informationen zum Kunden sichere, wie z.B. IP ...

Windows Tools

Empfehlung Dokumentation Lizenzmanagement

gelöst Frage von xbast1xWindows Tools5 Kommentare

Hallo zusammen, durch ein Microsoft SAM bin ich nun auf der Suche nach einem Tool (möglichst kostenfrei) um den ...

Netzwerke

Dokumentation, Computer, Beamer,

Frage von Andreas-scaNetzwerke3 Kommentare

Sehr geehrte IT-Profis, wir sind eine Schule und haben an unserem Standort über 100 Räume in denen fast in ...

Neue Wissensbeiträge
Drucker und Scanner

Kyocera PCL Barcode Flash SD v3.0 Firmware Update installieren

Tipp von Mana vor 2 TagenDrucker und Scanner1 Kommentar

Ich hatte eine vorhandene "PCL Barcode Flash SD v3.0 Type D/E", die bisher in einem Kyocera FS-4200DN verbaut war. ...

Sicherheit
0-day Schwachstelle im Internet Explorer
Information von kgborn vor 6 TagenSicherheit3 Kommentare

In Microsofts Internet Explorer gibt es eine 0-day Schwachstelle in der Scripting Engine, die faktisch alle Browser- und Windows-Versionen ...

Internet

Internet-Speedtest Automatisieren via Befehlszeile, cmd, Bash (Windows, Linux, FreeBSD, Mac)

Tipp von anteNope vor 7 TagenInternet6 Kommentare

Also das hier ist irgendwie an mir vorbeigegangen. Einfacher geht es schlicht nicht mehr. Mit "-s 28624 wähle ich ...

Administrator.de Feedback

Entwicklertagebuch: Codeblöcke auf unseren Seiten

Information von admtech vor 7 TagenAdministrator.de Feedback26 Kommentare

Hallo Administrator User, Unsere Codeblöcke werden ab sofort anders dargestellt. In Zukunft kommen neue Typen dazu. Hier ein Beispiel ...

Heiß diskutierte Inhalte
Windows Server
Gruppenrichtlinie Basisordner
Frage von opc123Windows Server18 Kommentare

Hallo, es gibt ja die GPO "User Basis Ordner" Ich habe diese auf ein Netzlaufwerk aktiviert. Der Ordner wird ...

LAN, WAN, Wireless
Server LAN nicht möglich, Alternativen?
gelöst Frage von mrlnbllmnnLAN, WAN, Wireless16 Kommentare

Moin, ich stelle demnächst in meinem Keller einen Server auf und möchte diesen natürlich mit meinem Heimnetz verbinden. Ich ...

LAN, WAN, Wireless
Verkabelung einer Richtfunkstrecke
gelöst Frage von KompatibelLAN, WAN, Wireless13 Kommentare

Guten Tag! Ich bräuchte einen Ratschlag zur korrekten Verkabelung der Module einer WLAN-Richtfunkstrecke. Die aktuelle Situation ist wie folgt: ...

Netzwerkmanagement
Windows 10 Client Internet sperren für einzelnen User
Frage von holliknolliNetzwerkmanagement13 Kommentare

Hallo liebe alle, stehe vor dem Problem, für einen Domain-User das Internet komplett sperren zu müssen, allerdings lokale LAN-Ressourcen ...