Прескачане към съдържанието

Panolayer Studio · Живи документи

Документация, която можете да сверявате с кода.

Задайте въпрос за която и да е част от кодовата си база и Panolayer ще напише документ въз основа на архитектурата, която е анализирал, като твърденията в него са свързани с файловете и функциите, които описват. Когато кодът се промени, генерирайте го отново с едно щракване.

macOS 15 на Apple silicon · Безплатно за начало · Не се изисква кредитна карта

Living Documents

A Panolayer Studio living document showing 22 claims linked to source, its outline, and linked files and functions.

Пълен размер · превърти, за да разгледаш детайлите

Документацията беше вярна в деня, в който някой я написа.

После agent преработи handler-а за харесвания, преименува два файла и промени какво връща маршрутът. Никой не обнови документацията, защото никой не забеляза, че е остаряла. Следващият agent все пак я прочете.

Как работи

От въпрос до документ, който можете да проверите

01

Питайте за всяка част от кодовата база

Въведете тема, например „Как работи превключването на харесване от край до край“, и Panolayer създава документ по архитектурата: компонентите, маршрутите и функциите, които участват, в реда, в който заявката преминава през тях.

Ask a question. Create a document.

Ask a question. Create a document.

The user types How does posting work to Panolayer Agent, reads its source-linked explanation, and selects Create Documentation to generate a living document.

Пълен размер · превърти, за да разгледаш детайлите

02

Твърдения, свързани с източника

Имената на файлове и символи в документа водят към кода, който описват, и всеки документ показва колко от твърденията му са свързани, например „22 твърдения, свързани с източника“. Ако изречение изглежда грешно, можете да го проверите спрямо кода.

Claims linked to source

Claims linked to source

A Panolayer Studio living document with 22 claims linked to source and links to LikeButton, the like route and lib/likes.ts.

Пълен размер · превърти, за да разгледаш детайлите

03

Вашите правила до кода, който защитават

Когато правило на Guardian регламентира кода, документът го цитира, например „харесванията се проследяват за всеки зрител“. Всеки, който чете — човек или agent — вижда ограничението до кода, за който се отнася.

Guardian rule

Guardian rule

A Guardian rule quoted in a Panolayer Studio living document: likes are tracked per viewer, never a single shared global counter.

Пълен размер · превърти, за да разгледаш детайлите

04

Регенерирайте при промяна на кода

С едно щракване документът се преизгражда от текущия код и номерът на версията му се увеличава, така че да различите нов документ от стар.

Regenerate a living document

Regenerate a living document

A Panolayer Studio document card being regenerated, showing Generating and then an updated date and version v2.

Пълен размер · превърти, за да разгледаш детайлите

05

Запазете документацията, която вече имате

Panolayer намира Markdown файловете, които вече са в repository-то ви, като README.md, AGENTS.md и всичко в docs/, и ги изброява до документите, които е създал, групирани по папки.

Repository documents

Repository documents

Panolayer Studio lists existing AGENTS.md and README.md files alongside documents grouped under docs and docs/features.

Пълен размер · превърти, за да разгледаш детайлите

ЧЗВ

Въпроси

Нещо друго? Свържете се с нас и ще отговорим.

С какво живият документ се различава от README?

README се пише веднъж и се разминава с кода. Живият документ се пише от архитектурата, която Panolayer е извлякъл от кода ви, свързва твърденията си с изходния код и може да бъде регенериран при всяка промяна на кода.

Писан ли е от модел?

Да. Модел пише текста, работейки върху структурата, която Panolayer е извлякъл от изходния код. Затова твърденията водят обратно към кода: можете да проверите всяко от тях срещу това, което описва.

Какво мога да поискам?

Всичко за кодовата база: как работи дадена функционалност от край до край, основните характеристики на проекта, как се свързва архитектурата. Документите се маркират по област, като Architecture, API и Components.

Колко мога да създам?

Безплатният план включва 2 живи документа. Pro включва неограничен брой живи документи и споделяне. Вижте цените.

Документация, която можете да сверявате с кода.

Безплатно за начало · Не е необходима кредитна карта

Следващо: Промени