Jedes Dokumentations-Tool kann einen Artikel hosten. Keines weiß, wann ein gemergter PR ihn gerade falsch gemacht hat. Ellie Docs verbindet sich mit Ihrem GitHub-Repository, verfolgt den Code, von dem jeder Artikel tatsächlich abhängt, und markiert den Artikel in dem Moment, in dem er veraltet, und entwirft gleich die Korrektur dazu.
Ohne Karte · Anmeldung mit Google, Microsoft, GitHub oder E-Mail
Ein Feld in der API wird umbenannt. Ein Endpunkt wird als veraltet markiert. Ein UI-Ablauf wird neu gestaltet. Der PR wird sauber gemergt, die Tests laufen durch, und der Hilfeartikel zum alten Verhalten bleibt stehen, korrekt aussehend und still falsch, bis ein Kunde oder ein Support-Ticket es bemerkt.
Jeder Artikel kann mit dem Code, den Endpunkten oder der API-Spezifikation verknüpft werden, die er tatsächlich dokumentiert, sodass Ellie Docs genau weiß, was zu beobachten ist.
Eine GitHub App beobachtet gemergte PRs, beurteilt, ob sie einen verknüpften Artikel betreffen, und markiert ihn, mit einer fertigen Überarbeitung zur Prüfung statt nur einem roten Banner.
Sie haben eine OpenAPI-Spezifikation? Ellie hält die Referenz damit synchron und prüft jede Version auf Breaking Changes. Keine Spezifikation? Ellie leitet sie aus Ihren Routen und Request-Validatoren ab und nennt für jedes Feld den zugrunde liegenden Code.
Installieren Sie die Ellie Docs GitHub App auf den Repositories, von denen Ihre Produktdokumentation abhängt. Wir bewahren keine Kopie Ihres Repositorys auf: Der Code wird abgerufen, wenn Ellie ihn lesen muss, und später per Commit erneut geholt.
Holen Sie bestehende Dokumentation per Crawl-Import herein oder starten Sie neu. Ellie Docs entwirft Artikel und verknüpft jeden mit dem Code, den Endpunkten oder der Spezifikation, von denen er abhängt.
Betrifft ein Merge einen verknüpften Artikel, markiert Ellie ihn und entwirft die Überarbeitung. Ihr Team prüft eine Liste vorgeschlagener Korrekturen, statt zu suchen, was kaputtgegangen ist.
Eine GitHub App, beschränkt auf die Repositories, die Sie auswählen. Wir bewahren keine Kopie Ihres Repositorys auf: Ellie ruft den Baum ab, wenn sie ihn lesen muss, und holt ihn danach per Commit erneut. Gespeichert wird nur das abgeleitete Material, auf dem ein Artikel steht: die Auszüge und Quellenangaben hinter jeder Aussage, damit sich jede Behauptung in Ihrer Dokumentation auf den Code zurückführen lässt, der sie belegt. Geheimnisse in Dateien werden vor dem Speichern geschwärzt, und Ihr Code wird nie zum Training von Modellen verwendet.
Ja, das ist die Absicht. Ellie Docs hostet und rendert das öffentliche Help-Center direkt, einschließlich eigener Domains, sodass Sie nicht zwei Systeme parallel betreiben.
Ja. Richten Sie Ellie Docs auf eine Spezifikation, und es pflegt die Referenz daraus und gleicht sie bei jeder neuen Version Ihrer API ab. Ohne Spezifikation leitet Ellie sie aus Ihrem Code ab: Endpunkte aus Ihrem Router, Feldtypen aus Ihren Request-Validatoren, und für alles, was der Code nicht ausdrücklich festlegt, eine Untersuchung, die die Zeilen nennen muss, aus denen sie jedes Feld abgeleitet hat. Abgeleitete Endpunkte bleiben privat, bis Sie sie geprüft haben, damit interne Routen nicht in Ihre öffentliche Referenz gelangen.
Kombinieren Sie Ellie Docs mit Ellie Desk (früher Zugang): Gelöste Support-Tickets lassen sich mit einem Klick in neue Artikel verwandeln, und die KI-Entwürfe von Desk stützen sich automatisch auf Ihre veröffentlichte Dokumentation.
Kostenloser Tarif, danach ab $65/Monat bei jährlicher Abrechnung. Preise ansehen →
