如何构建更新日志页面:条目、标签、RSS 与“最新动态”
更新日志页面是一份按日期排列的产品变更列表,最新的排在最前,专为使用产品的人撰写。要构建它,你需要带日期、清晰标题、简短说明和标签(新增、改进、修复)的条目,一个列出这些条目的页面,每个条目各自的 URL,最好还有 RSS 订阅源,以及告诉用户有新内容的方式。这是你能构建的最简单的功能之一,主要决定在于条目存放在哪里:是网站中的文件,还是带管理页面的数据库。
为什么值得有一份更新日志
更新日志向客户和潜在客户表明产品一直在维护。当有人问“它是否已经支持 X?”时,支持和销售人员可以直接发给他们一个链接。它也是闭合反馈循环的地方:当一项被请求的功能上线时,更新日志条目就是你指给人们看的内容。如果你运行着客户反馈门户,请把已上线的需求直接链接到它们对应的条目。
更新日志不是你的内部提交历史。“重构了计费服务”对用户没有任何意义;“发票现在会显示贵公司的增值税号”则有意义。
页面需要什么
每个条目的内容
| 字段 | 说明 |
|---|---|
| 标题 | 从用户视角描述改变了什么 |
| 日期 | 发布日期,显示在页面上 |
| 标签 | 新增、改进、修复(也可以有移除或安全) |
| 正文 | 几句话或几条要点;如何使用,适用于谁 |
| 图片或视频 | 可选;一张截图往往比一段文字更有说服力 |
| Slug | 条目的 URL,例如 /changelog/invoice-vat-numbers |
| 状态 | 草稿或已发布,如有需要还可设定定时发布日期 |
页面
- **更新日志索引:**最新的排在最前,带标签筛选,以及简单的分页或“加载更多”。
- **条目页面:**每个条目一个 URL,方便链接和分享。
- **RSS 或 Atom 订阅源:**让人们和工具无需邮件即可关注更新。
- 管理页面(仅限数据库版本):撰写、预览、定时并发布条目。
应用内的附加功能
- **“最新动态”提示:**当有用户尚未看过的条目时,在菜单项上显示一个小圆点。为每位用户或在浏览器中存储其上次打开的最新条目的日期。
- **邮件摘要:**发送给选择加入的用户。这需要一个发送服务商;参见如何从应用发送邮件。
主要决定:文件还是数据库
以网站中的文件存放条目
每个条目都是项目中的一个 Markdown 文件。发布条目就是添加一个文件并重新部署。这是最简单也最稳健的方式:不需要数据库,没有管理登录,无需保护任何东西,而且页面可以预渲染,因此加载很快,搜索引擎也容易读取。
它适合那些撰写条目的人愿意请 AI 构建器帮忙或直接编辑文件的团队。
以数据库加管理页面存放条目
条目保存在数据表中,一个私有的管理页面让团队中的任何人都能撰写、预览、定时并发布。它适合由营销或支持人员撰写更新的团队,或者你需要定时发布,或按受众发布不同条目的情况(例如,只向企业客户展示企业功能)。
代价是构建和维护的成本更高:需要管理登录、图片上传,还要确保公开页面仍然能被搜索引擎读取;如果页面只在浏览器中加载条目,搜索引擎可能读不到内容。
| 文件 | 数据库 + 管理页面 | |
|---|---|---|
| 谁可以发布 | 任何能编辑项目的人 | 任何拥有管理员登录的人 |
| 设置 | 极简 | 登录、存储、管理界面 |
| SEO | 容易(页面可预渲染) | 需要注意,确保页面在服务端渲染或预渲染 |
| 定时发布 | 部署时发布 | 可按日期定时 |
| 托管成本 | 静态 | 需要运行中的应用和数据库 |
写出人们愿意读的条目
- 以好处开头。 “将报表导出为 Excel”比“新的导出模块”更好。
- 说明适用对象。 所有套餐、仅限 Pro、本周逐步推出。
- 展示出来。 一张截图或一段短视频。
- 合并小修复。 每周一条“修复与改进”,用要点列出,可以避免页面被大量条目淹没。
- 诚实地说明移除的内容。 如果某项功能即将下线,说明何时下线,以及该用什么替代。
一条有效的首条提示
在我们网站的 /changelog 添加一个公开的更新日志。每个条目是一个 Markdown 文件,包含标题、日期、标签(新增、改进或修复)、可选的封面图和正文。索引页面按最新排序列出条目,显示日期、标签和第一段,带有标签筛选按钮,每页显示 10 个条目。每个条目有自己的页面,位于 /changelog/<slug>,并为搜索引擎提供恰当的页面标题和描述。在 /changelog/rss.xml 添加 RSS 订阅源。创建三个示例条目。与现有网站设计保持一致,在手机上保持可读,并预渲染页面以加快加载速度。
对于数据库版本,把第一句替换为:“将条目存储在数据库中,包含草稿/已发布状态和发布日期,并添加一个受密码保护的管理页面,用于撰写、预览和发布条目。”
构建步骤
- 根据上面的表格决定使用文件还是数据库。
- 构建索引页和条目页,并放入几个示例条目。
- 添加标签和筛选。
- 添加 RSS 订阅源,并在页面上链接它。
- 为每个条目添加页面标题、描述和站点地图条目。 我们的AI 构建网站的 SEO 指南涵盖了基础内容。
- 管理页面和登录,如果你选择了数据库方案。
- 在应用中添加“最新动态”提示。
- 撰写过去几个月的真实条目,这样页面上线时不会空空如也。
常见错误
- 直接复制提交信息。 请为用户撰写,而不是为开发者。
- 一个巨大的页面,没有每个条目的 URL。 没有人能链接到某个具体的变更,搜索引擎看到的也只是一个页面,而不是许多页面。
- 更新在一个月后就停止。 一年前才最后更新的更新日志,会让人觉得产品已被弃用。请设定一个你能坚持的节奏。
- 只在浏览器中加载条目。 搜索引擎和链接预览可能看到的是空白页面。请预渲染或在服务端渲染。
- 把故障信息混入其中。 停机应放在状态页面中,而不是更新日志里。
何时托管的更新日志工具更好
市面上有托管的更新日志和产品更新工具,有些还内置于反馈看板或应用内小组件中。如果你希望不自己构建就能获得应用内弹窗、受众定位和分析功能,或者你的团队已经为包含此功能的工具付费,它们就值得考虑。你的博客或帮助中心软件可能也已经有合适的格式。
如果你希望更新日志位于自己的域名下,采用自己的设计,并且可以被完整索引,那么就自己构建。对于一个简单的带日期帖子列表来说,工作量并不大。
使用 Mythex 构建
在 Mythex 中,你可以让代理为现有项目添加更新日志,或将其构建为一个独立的小型网站,并在构建过程中于实时预览中查看。基于文件的版本不需要数据库。如果你选择管理页面版本,当条目需要保存时,代理会添加一个专用的 Postgres 数据库(或输入 /database),截图则存放在项目的文件存储中。管理员登录需要你用自己的认证方式添加(添加登录指南)。
新的 Mythex 应用通常是客户端渲染的单页应用,而SEO 指南指出这种方式对搜索不利,因此如果希望条目能被搜索到,请要求生成静态或预渲染的更新日志页面。同一份指南也涵盖了标题、描述和站点地图。如需一个内置更新日志的起点,可以参考产品知识中心模板。
常见问题
一条更新日志条目应该包含什么?
日期、一个简短的标题(说明对用户而言改变了什么)、几句话或几条要点来解释、一个标签(例如“新增”“改进”或“修复”),以及可选的截图和更多详情的链接。
更新日志需要数据库吗?
不一定。如果只有一两个人发布更新,条目可以以 Markdown 文件的形式存放在网站中,并随每次部署发布。当非技术人员需要通过管理页面撰写和定时发布条目时,再使用数据库。
我应该多久更新一次更新日志?
每当用户会注意到的变化发生时就更新。许多小型产品每周或每两周汇总一次变更;重要的是保持稳定的节奏,让页面看起来一直在活跃更新。
更新日志对 SEO 有帮助吗?
会有一点帮助:每个条目都是关于某项功能的、可被抓取的页面;而定期更新的页面也表明产品仍在积极维护。请为每个条目分配自己的 URL 和描述性的标题。