跳至內容

Panolayer Studio · 活文件

能與程式碼核對的文件。

詢問程式碼庫的任何部分,Panolayer 就會根據它解析出的架構撰寫文件,並將其論述連結到所描述的檔案與函式。程式碼變更時,一鍵即可重新產生。

macOS 15(Apple 芯片)· 免费开始使用 · 无需信用卡

Living Documents

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

完整截圖 · 捲動以查看詳細內容

这些文档在撰写当天是正确的。

后来,一个 agent 重构了点赞处理程序,重命名了两个文件,并改变了该路由的返回内容。没有人更新文档,因为没有人注意到它们已经过时。下一个 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,例如 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。

我可以建立多少份?

Free 方案包含 2 份 living documents。Pro 方案包含無限份 living documents,以及分享功能。查看定價。

能與程式碼核對的文件。

免費開始使用 · 無需信用卡

下一步:变更