Worin unterscheidet sich ein lebendes Dokument von einer README?
Eine README wird einmal geschrieben und driftet danach ab. Ein lebendes Dokument wird aus der Architektur erstellt, die Panolayer aus dem Code geparst hat, verknüpft seine Aussagen mit der Quelle und lässt sich neu generieren, wann immer sich der Code ändert.
Wird es von einem Modell geschrieben?
Ja. Ein Modell schreibt den Fließtext auf Grundlage der Struktur, die Panolayer aus dem Quellcode geparst hat. Deshalb verweisen die Aussagen zurück auf den Code: Jede davon lässt sich mit dem abgleichen, was sie beschreibt.
Was kann ich anfordern?
Alles über die Codebasis: wie ein Feature von Anfang bis Ende funktioniert, die Hauptfunktionen des Projekts, wie die Architektur zusammenspielt. Dokumente werden nach Bereichen getaggt, etwa Architecture, API und Components.
Wie viele kann ich erstellen?
Free enthält 2 lebende Dokumente. Pro enthält unbegrenzt viele lebende Dokumente sowie Sharing. Preise ansehen.