Hoe verschilt een levend document van een README?
Een README wordt één keer geschreven en raakt daarna verouderd. Een levend document wordt geschreven op basis van de architectuur die Panolayer uit je code heeft geparseerd, koppelt de beweringen aan de bron en kan opnieuw worden gegenereerd wanneer de code verandert.
Wordt het door een model geschreven?
Ja. Een model schrijft de tekst op basis van de structuur die Panolayer uit je broncode heeft geparseerd. Daarom verwijzen de beweringen terug naar de code: je kunt elke bewering toetsen aan wat ze beschrijft.
Waar kan ik om vragen?
Alles over de codebase: hoe een functie end-to-end werkt, de belangrijkste onderdelen van het project, hoe de architectuur in elkaar zit. Documenten worden getagd per gebied, zoals Architectuur, API en Componenten.
Hoeveel kan ik er maken?
Free bevat 2 levende documenten. Pro bevat onbeperkt levende documenten en delen. Bekijk prijzen.