文档

发布工作流

记录新增文章或文档时的最小流程,避免每次重新想一遍。

更新于

这份工作流要尽量简单,复杂了就很难坚持。

写文章时

src/content/posts/ 下新建 Markdown 或 MDX 文件,并至少补齐这些 frontmatter:

title: '文章标题'
description: '一句话摘要'
pubDate: '2026-03-27'
tags:
  - Writing

建议发布前至少检查三件事:

  1. 标题是否明确。
  2. 摘要是否能独立说明这篇文章写什么。
  3. 是否真的值得进入公开时间线。

写文档时

文档放在 src/content/docs/,优先按主题归类,而不是按日期归类。

例如:

src/content/docs/getting-started/start-here.md
src/content/docs/reference/content-style-guide.md

文档适合放这些内容:

  • 长期有效的写作规范。
  • 站点结构说明。
  • 以后高概率会反复查阅的个人笔记。