AGENTS.md
本文件是仓库给 AI 编码代理(Codex / Claude 等)的工作约定。写博客文章时必须遵守以下标准。
博客文章写作标准
1. 文件与元数据
- 文章放在
_posts/下,文件名YYYY-MM-DD-<英文短横线 slug>.md。 - Front matter 必须包含:
layout: post、title(中文)、description(一句话摘要)、date: YYYY-MM-DD 00:00:00 +0800、categories(一级+二级,如[技术, 操作系统]、[技术, Linux])、tags(若干中文/英文标签)。 - 图一律用 ` ```mermaid ` 代码块(站点已在
default.html全局加载 mermaid.js)。
2. 可读性
- 面向零基础读者,中文写作,生活化比喻优先,少堆术语。
- 引入任何专业术语都要顺带解释清楚(例如”消息边界”“方向”“页表”)。
- 结构建议:先”一句话/一张图”建立整体印象 → 逐个模块按”是什么 → 怎么用 → 原理是什么”展开 → 对比表 → 总结。
- 小节用中文数字编号(〇、一、二、三……)。
3. 图
- 每篇至少一张架构图 + 一张时序图。
- 图要清晰、不重叠:用
subgraph给节点分组,方向用箭头表达(单向-->、双向<-->、通知-.->)。
4. 代码
- 代码必须完整、自包含:不能假设前面某一步已做过(例如 FIFO 示例必须自带”不存在就创建”)。
- 每个代码示例都要逐行注释,说明每句在干什么。
- 代码必须正确:排查隐蔽 bug(缓冲区清零、字符串结尾
\0、头文件齐全、参数顺序等)。 - 给出编译 / 运行方式。
5. 交付
- 改完直接
git add+git commit+git push origin main,不需要再向用户确认。