Перейти к содержимому

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.

Полный снимок · прокрутите, чтобы рассмотреть детали

Документация была верна в тот день, когда её написали.

Затем агент отрефакторил обработчик лайков, переименовал два файла и изменил то, что возвращает маршрут. Никто не обновил документацию, потому что никто не заметил, что она устарела. Следующий агент всё равно её прочитал.

Как это работает

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

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 регулирует код, документ цитирует его, например «лайки отслеживаются для каждого зрителя». Любой читатель — человек или агент — видит ограничение рядом с кодом, который оно охватывает.

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, уже присутствующий в вашем репозитории, например 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 извлёк из вашего исходного кода. Именно поэтому утверждения ссылаются обратно на код: любое из них можно проверить по тому, что оно описывает.

Что можно запросить?

Что угодно о кодовой базе: как функция работает от начала до конца, главные возможности проекта, как устроена архитектура. Документы помечаются по областям, например «Архитектура», «API» и «Компоненты».

Сколько их можно создать?

Бесплатный план включает 2 живых документа. Pro включает неограниченное число живых документов и общий доступ. См. тарифы.

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

Начать бесплатно · Без банковской карты

Далее: Изменения