Czym różni się dokument żywy od README?
README powstaje raz i z czasem się rozjeżdża. Dokument żywy powstaje na podstawie architektury, którą Panolayer odczytał z Twojego kodu, wiąże swoje twierdzenia ze źródłem i można go wygenerować ponownie za każdym razem, gdy kod się zmieni.
Czy pisze go model?
Tak. Prozę pisze model, opierając się na strukturze, którą Panolayer odczytał z Twojego kodu źródłowego. Dlatego twierdzenia prowadzą z powrotem do kodu: każde z nich możesz sprawdzić względem tego, co opisuje.
O co mogę poprosić?
Wszystko o bazie kodu: jak działa funkcja od początku do końca, jakie są główne funkcje projektu, jak łączy się architektura. Dokumenty są oznaczone tagami obszarów, takich jak Architektura, API i Komponenty.
Ile mogę ich utworzyć?
Plan Free obejmuje 2 żywe dokumenty. Plan Pro obejmuje nieograniczoną liczbę żywych dokumentów oraz udostępnianie. Zobacz cennik.