让内容成为可以积累的档案

从文章、引用与稳定链接开始,搭建一个可以长期维护的写作空间。

这是一篇示例文章,用于展示技术写作、内部链接和内容组织。

从一份内容开始

一个长期维护的网站,可以先解决一个具体问题:写下一篇文章以后,怎样让它在几个月后仍然容易找到、理解和修订?

文章正文使用 Markdown,标题、摘要、分类和日期写在文件开头。页面从这些信息生成列表和归档,让作者把注意力放在内容本身。

给内容一个稳定的位置

标题可以修改,分类也可以调整。文章的永久链接应当尽量保持不变。

例如,这篇文章使用固定的 slug: content-as-an-archive。它的地址与文件夹名称、分类和发布日期分开维护。

信息作用
标题告诉读者这篇文章讨论什么
摘要帮助读者决定是否继续阅读
分类提供主要阅读方向
标签连接多个主题中的相似内容
更新日期表明内容最近一次实质修订

让引用连接内容

当两篇文章存在明确联系时,可以直接在正文中加入链接。比如,发布一篇文章的流程说明如何添加内容;A* 寻路示例展示代码、公式与图形的排版。

组织内容的目的,是让下一次阅读和修改更容易。

记录修订

内容发布以后仍然可以继续修改。更新正文后填写 updatedAt,Git 会保存文件历史。初期只维护一个公开地址,不必为每次修改生成新的公开页面。

延伸阅读

所属系列:个人网站笔记

  1. 让内容成为可以积累的档案(当前文章)
  2. 把一篇文章发布到这里