En quoi un document vivant diffère-t-il d’un README ?
Un README est écrit une fois puis dérive. Un document vivant est rédigé à partir de l’architecture que Panolayer a extraite de votre code, relie ses affirmations au code source et peut être régénéré dès que le code change.
Est-il écrit par un modèle ?
Oui. Un modèle rédige le texte en s’appuyant sur la structure que Panolayer a extraite de votre source. C’est pourquoi les affirmations renvoient au code : vous pouvez vérifier chacune d’elles par rapport à ce qu’elle décrit.
Que puis-je demander ?
Tout ce qui concerne le codebase : le fonctionnement de bout en bout d'une fonctionnalité, les principales fonctionnalités du projet, l'articulation de l'architecture. Les documents sont étiquetés par domaine, comme Architecture, API et Components.
Combien puis-je en créer ?
L'offre Free inclut 2 living documents. L'offre Pro inclut un nombre illimité de living documents, ainsi que le partage. Voir les tarifs.