Entwicklung & Design

Übersichtlich, einfach und hübsch: Mit Readme.io schnell zur fertigen Dokumentation

Readme.io. (Grafik: Readme.io)

Egal ob eine einfache Dokumentation oder eine vollständige Entwickler-Community: Mit Readme.io soll beides schnell und einfach gehen. Wir haben uns den Dienst für euch angeschaut.

Mit Readme.io könnt ihr schnell Online-Dokumentationen erstellen. (Screenshot: Readme.io)

Mit Readme.io könnt ihr schnell Online-Dokumentationen erstellen. (Screenshot: Readme.io)

Mit Readme.io schnell eine zentrale Anlaufstelle für Entwickler schaffen

Gregory Koberger, einer der Gründer von Readme.io, hat schon bei verschiedenen Startups gearbeitet. Dabei will ihm aufgefallen sein, wie viel Zeit bei jeder dieser Unternehmungen für die Erstellung von Dokumentationen und API-Referenzen draufgegangen ist. Wer hier aber Zeit spart, kann Probleme damit bekommen, eine ausreichende Anzahl von Entwicklern von dem eigenen Angebot zu überzeugen. Genau deswegen hat er Readme.io entwickelt.

Dabei handelt es sich um eine Plattform, mit der die Erstellung von Dokumentationen und API-Referenzen enorm vereinfacht werden soll. Readme.io ist als zentrale Anlaufstelle für Entwickler gedacht, die sich mit eurem SDK, eurer API oder eurem Framework vertraut machen wollen. Die Entwickler können sich auch direkt einbringen und über Readme.io Verbesserungen anregen oder direkt Fragen stellen. Wer sich anschauen will, wie Readme.io im Einsatz aussieht, sollte einen Blick auf Mozilla Brick werfen.

Readme.io bietet auch eine Möglichkeit zur Versionsverwaltung. (Screenshot: Readme.io)

Readme.io bietet auch eine Möglichkeit zur Versionsverwaltung. (Screenshot: Readme.io)

Readme.io bietet eine Versionskontrolle und eine GitHub-Integration

Readme.io unterstützt Markup zur Verwendung eurer Dokumentation. Außerdem lassen sich Dokumentationen direkt von GitHub importieren. Dieses Feature konnten wir allerdings nicht testen, da die Funktion aufgrund von Überlastung derzeit deaktiviert ist. Intern nutzt Readme.io eine eigene Versionsverwaltung, mit der sich Dokumente in verschiedenen Stadien verwalten lassen. Neben verschiedenen Templates können Nutzer von Readme.io auch eigene CSS-Themes erstellen sowie eigenen JavaScript-Code einbinden. Das Hosting übernimmt der Anbieter.

In der kostenlosen Version könnt ihr Readme.io zur Erstellung einer einfachen Dokumentation ohne zusätzliche CSS-Anpassungen verwenden. Für derzeit knapp 59 US-Dollar pro Monat könnt ihr eure Seite zusätzlich anpassen, bekommt einen interaktiven API-Explorer und API-Browser, könnt die Landingpage anpassen und Readme.io mit bis zu zehn Administratoren nutzen. Auch der Einsatz einer eigenen Domain ist ab diesem Paket möglich. Firmen zahlen für eine White-Label-Lösung etwa 299 US-Dollar pro Monat und erhalten darüber hinaus die Möglichkeit, eigene Widgets in Readme.io einzubingen.

1 von 9

via news.ycombinator.com

Bitte beachte unsere Community-Richtlinien

Wir freuen uns über kontroverse Diskussionen, die gerne auch mal hitzig geführt werden dürfen. Beleidigende, grob anstößige, rassistische und strafrechtlich relevante Äußerungen und Beiträge tolerieren wir nicht. Bitte achte darauf, dass du keine Texte veröffentlichst, für die du keine ausdrückliche Erlaubnis des Urhebers hast. Ebenfalls nicht erlaubt ist der Missbrauch der Webangebote unter t3n.de als Werbeplattform. Die Nennung von Produktnamen, Herstellern, Dienstleistern und Websites ist nur dann zulässig, wenn damit nicht vorrangig der Zweck der Werbung verfolgt wird. Wir behalten uns vor, Beiträge, die diese Regeln verletzen, zu löschen und Accounts zeitweilig oder auf Dauer zu sperren.

Trotz all dieser notwendigen Regeln: Diskutiere kontrovers, sage anderen deine Meinung, trage mit weiterführenden Informationen zum Wissensaustausch bei, aber bleibe dabei fair und respektiere die Meinung anderer. Wir wünschen Dir viel Spaß mit den Webangeboten von t3n und freuen uns auf spannende Beiträge.

Dein t3n-Team

4 Kommentare
Christian Kaps
Christian Kaps

Read the Docs ist eine gute Alternative. Hat die gleiche Funktionalität wie Readme.io ist aber komplett kostenlos. https://readthedocs.org

Antworten
Kai
Kai

„Readme.io unterstützt Markup zur Verwendung eurer Dokumentation.“
> Ihr meint MarkDOWN, oder?

Antworten
BastianBalthasarBux

„wie viel Zeit bei jeder dieser Unternehmungen für die Erstellung von Dokumentationen und API-Referenzen draufgegangen ist.“

Wohl noch nie was gehört von phpdoc/javadoc/doxygen?

Viel einfacher geht’s ja nun wirklich nicht mehr.
Und man hat den Vorteil, dass man die Kontext-abhängige Dokumentation auch gleich im „Intellisense“ der IDE hat. Soweit ich weiss wird das Format von allen wichtigen IDEs unterstützt, wie Visual Studio, Eclipse und Derivate, phpStorm, oder meinem ganz besonderen Liebling: KDevelop.

Antworten

Melde dich mit deinem t3n Account an oder fülle die unteren Felder aus.