关于 living-artifacts
living-artifacts 是面向文档作者的 Markdown 技能，帮助内容在事实变化后仍可核验。它要求为易变快照附上重现方式，并优先引用权威来源。
主要功能
- 01为快照配套重现命令
- 02标注可能变化的值
- 03为具体文件路径添加链接
- 04区分事实与假设
- 05引用权威信息源
适用场景
- 01记录可能变化的项目布局
- 02注明当前版本或状态
- 03在 Markdown 文档中引用文件
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/living-artifacts确认已加载。
详细介绍
持续更新的文档
编写任何 Markdown 文档时，每个静态状态快照都必须附上可重新生成它的命令、查询或脚本。读者之后应当能够自行重新推导出该值，而无需猜测其来源。
什么算作快照
任何可能在编写和阅读之间发生变化的内容：
- 文件树、目录列表、项目布局
- 端口号、主机名、URL、文件路径
- 版本号、已部署的提交、镜像标签
- 行数、表格内容、API 响应正文
- 用户、仓库、表、服务、环境变量列表
- “当前失败的测试”或其他状态快照
- 在其他地方有规范来源的配置值
- 计数和汇总值
模式
对于每个快照，请在附近包含：
- 复现方法优先——能生成该值的精确命令、查询或脚本。
- 快照——明确说明这是编写时的视图，而非永久事实。
- 变更提示——简短说明该值可能已发生变化，可通过复现方法刷新。
单一事实来源
如果某个值已有规范来源，请引用该来源，而不要在文档中重复该值。
| 不推荐 | 推荐 |
|---|---|
| 在文档中硬编码端口 | 引用定义该端口的环境变量或配置 |
| 在 README 中手动列出名称 | 指向相应目录或生成的列表 |
| 硬编码 Git SHA | 使用可在读取时解析 SHA 的命令 |
| 将 API 字段列表复制到文档中 | 使用能检查实时 API 的命令 |
文件引用必须可点击
只要 Markdown 文档提及了具体文件路径，就应将其包装为 Markdown 链接，方便读者跳转到文件，并快速发现失效链接所暴露的变更。
适用于：
- 源文件
- 配置文件
- 同级文档
- 脚本
- Skill 文件
- 供读者检查的生成文件
使用相对于 Markdown 文件所在位置的路径。不要链接占位符、通配符或代码块中类似路径的 CLI 片段。
事实与假设
- 事实可以立即核验，应提供复现方法。
- 假设目前无法核验，必须明确标注。
将测量事实与解释分开，以便读者区分观察结果和推断。
受众定位
面向用户的 README 用于最终用户。贡献者文档和 AGENTS.md 面向维护者。应将恰当详细程度的内容放在适合的位置。
自查
发布前，检查每个具体值并问自己：
- 三个月后它仍然正确吗？
- 如果不正确，旁边是否有复现方法？
- 读者运行复现方法后，能得到相同的值吗？
如果不能，这份文档就不完整。
评论
支持 Markdown