Hosting von Benutzerhandbüchern

Ich suche einen Online-Dienst zum Verfassen und Hosten von Software-Benutzerhandbüchern mit den folgenden Funktionen:

  • Cloudbasiert (öffentlicher Host), zuverlässig für langfristiges Hosting
  • Unterstützt mehrere Dokumente mit mehreren Abschnitten
  • Markdown-Syntax (vorzugsweise GitHub-Variante)
  • Einfaches Hochladen von Bitmaps
  • Inhaltsverzeichnis
  • Leserkommentare zulassen
  • Export als PDF (wünschenswert)
  • Kann kostenlos oder kostengünstig sein

Ich habe an ein Markdown-basiertes CMS gedacht, kann aber immer noch nicht das richtige finden.

Jamie, diese Seite dient eher der Empfehlung von Software als von Websites oder Online-Diensten.
@SteveBarnes: Klingt für mich themenbezogen und fragt nach bestimmten Funktionen wie Kommentaren und Inhaltsverzeichnissen. Es ist nicht nur HTML-Hosting.
Gratis? Was ist dein Budget? Möchten Sie das Urheberrecht behalten? Soll der Inhalt exportierbar sein, um Lock-in zu vermeiden? Alles öffentlich oder möchten Sie einige Teile auf einen bestimmten Personenkreis beschränken? Benötigen Sie Hyperlinks?
Das klingt nach Self-Hosting und damit on-topic. Habe ich es diesmal richtig gemacht?
ERKLÄRUNG : Ich möchte nicht selbst hosten. Deshalb erwähne ich zuverlässiges Langzeit-Hosting. Ich suche nach einer Art SaaS. Ich habe gerade manula.com gefunden , aber ich mag ihre nicht standardmäßige Markdown-Sprache nicht.
@NicolasRaoul, $0-$30 monatlich wären in Ordnung. Die Handbücher gehören zu urheberrechtlich geschützten Softwareprodukten und -diensten, sind jedoch öffentlich. Hyperlinks sind bisher nicht erforderlich.

Antworten (3)

Haben Sie Read The Docs in Betracht gezogen ?

  • Sie können Ihre Dokumente mit jedem gängigen Versionskontrollsystem importieren, einschließlich Mercurial, Git, Subversion und Bazaar.
  • Sie unterstützen Webhooks, sodass Ihre Dokumente erstellt werden, wenn Sie Code übertragen.
  • Es gibt auch Unterstützung für die Versionierung, sodass Sie Dokumente aus Tags und Zweigen Ihres Codes in Ihrem Repository erstellen können.
  • Die Hosting-Dokumentation ist kostenlos und einfach.
  • Dokumenterstellung in Markdown oder ReStructuredText
  • Bitmaps, SVG usw. werden einfach in Ihr Versionskontrollsystem übernommen.
  • Python -Sphinx- Unterstützung
  • Unterstützt mehrere Versionen von Dokumenten
  • Unterstützt Downloads als HTMLZip, PDF oder Epub.
  • Sie können den Quellcode für Ihre Bücher auf github, bithub usw. hosten.
  • Read the Docs ist selbst Open Source, sodass Sie eine Test- oder interne Instanz hinter einer Firewall ausführen können.
  • Durchsuchbar
  • Kommentare werden nicht direkt unterstützt, aber Sie können beispielsweise Links zu einem Ticketing-System auf Github einfügen oder Disqus verwenden .
  • Gehostet von Rackspace
  • Bei vielen Projekten wird die Dokumentation auf Read The Docs gehostet, daher erwarte ich eine gewisse Langlebigkeit.
Obwohl es für mich (einen Entwickler) attraktiv aussieht, sieht seine Nähe zu github für einen Dokumenteneditor und Leser ziemlich technisch aus. Der Mangel an Kommentarunterstützung ist ein Blocker, da ich nicht bereit bin, die Integration selbst vorzunehmen, sondern nach einer vollständigen Lösung eines Drittanbieters (SaaS) suche.
@Jaime - Halten Sie einen Schulungskurs für Ihre Entwickler zur Versionskontrolle ab - ich würde Mercurial (hg) vorschlagen, da es im Vergleich zu Git wirklich benutzerfreundlich ist - sobald sie feststellen, dass sie Versionen zurücksetzen können usw., Ihre Dokumentautoren und Redakteure werden die Versionskontrolle lieben , die Redakteure werden auch das Schuldzuweisungstool mögen.
Steve, meine Entwickler kennen sich mit Source Versioning sehr gut aus. Wer tut das heutzutage nicht? Aber Entwickler schreiben keine Benutzerhandbücher.
@Jaime - Tut mir leid, ich wollte einen Kurs für Ihre Autoren und Ihre Redaktion schreiben. Übrigens, Sie wären erstaunt über die Anzahl der Entwickler, die ich kenne, die glauben, dass die Versionskontrolle von Zeit zu Zeit einfach irgendwo anders hinkopiert wird, oft auf demselben Computer Dateien in SVN sowie .obj- und .pdb-Dateien.

Was ich gefunden habe, funktioniert tatsächlich gut, ist Github . Immerhin:

  • Unterstützt natives Github Markdown
  • Rendert Markdown, wenn Sie dorthin navigieren
  • Behält Versionen bei
  • Bietet kostenloses Hosting
  • Erlaubt Kommentare

Viele der Funktionen, die Sie interessieren.

caorogjin, ich bin vielleicht versucht, den manuellen redakteuren markdown beizubringen, aber github ist definitiv eine gute umgebung für die endbenutzer.

Stellen Sie sicher, dass Sie http://tome.host/ überprüfen

Es ist eine SaaS-Plattform zum Schreiben und Hosten von Dokumenten/Handbüchern, derzeit in der Beta-Phase.

Es unterstützt

  • mehrere Dokumente
  • mehrere Benutzer im selben Dokument
  • eine veröffentlichte Version haben, während Sie an einem Entwurf arbeiten
  • Bildunterstützung
  • Exportieren in verschiedene Formate und einiges mehr
Hosting von Benutzerhandbüchern
AntwortenHierDatenschutz-Bestimmungen1y, 0v