museum-documentation 是一种把技术系统写成像博物馆导览那样的叙事型文档风格,来源为 autumnsgrove/lattice。它的核心主张是“文档即待客之道,代码即策展藏品”,把作者定位为陪读者同行的向导,在进入实现细节前先回答“为什么”。
用途:面向非开发者读者(资料中称为 Wanderers)撰写文档;编写解释系统如何运作的知识库文章;为好奇的访客记录代码库、功能或系统;帮助中心里的“工作原理”内容;让技术内容显得亲切而非吓人;为未来知识库章节搭建展品;以及走通架构的入门文档。资料明确说明它不适用于 API 参考、技术规范和快速查阅指南。
主要能力与结构:展品遵循固定骨架,包括标题加副题、介绍读者正在看什么的“What You're Looking At”、按画廊或部分组织的导览结构、“Patterns Worth Stealing”可借鉴模式、“Lessons Learned”经验反思、“Continue Your Tour”相关链接,以及有意义的收尾署名。视觉元素包括 ASCII 流程图、对比表格和带上下文的代码块。组织方式上,整个代码库用 MUSEUM.md 作为入口,单个目录用 EXHIBIT.md,复杂功能用画廊结构。
使用方式:按上述结构组织内容,写作时遵循写作用“you”“we”、承认不完美、用短段落和变化句式等建议;避免破折号(em-dashes)、企业套话、生硬过渡词、“Not X, but Y”句式、被动语态、模糊措辞和堆砌比喻等。资料还提到可与 grove-documentation、grove-spec-writing、walking-through-the-grove 等技能配合,并在 UI 中使用 GroveTerm、GroveSwap、GroveText 组件及 markdown 中的 [[term]] 语法。
限制:资料主要给出写作风格、模板与检查清单,未提供具体安装命令、版本信息或平台支持范围,这些内容暂未提供。