8.3 KiB
8.3 KiB
name, description
| name | description |
|---|---|
| write-agent-blog | 为 llm-to-agent 的《Agent进阶专题》系列创作中文文章,并在项目 blog 目录输出单个 Markdown 文件。当用户要求为某次提交、代码变更、小功能点、路线图事项、里程碑或实现过程撰写、生成、修改博客或文章时使用,包括“为本次提交写篇文章”“给这个功能写博客”“记录这次实现”等表达。 |
创作 Agent 系列博客
为《Agent进阶专题》系列创作一篇以项目事实为依据的 Hexo 文章,并将成果保存为 <项目根目录>/blog/ 下的单个 Markdown 文件。
工作流程
- 使用
git rev-parse --show-toplevel定位项目根目录。 - 确定用户要求的写作范围。对于“本次提交”等表达,使用
git show检查HEAD;用户明确指向尚未提交的工作时,还要检查工作区变更。 - 阅读相关实现、测试、包脚本、路线图事项和功能文档。阅读已有的
blog/*.md,延续编号、术语和内容深度,并避免重复。 - 确定文章对应的单个小功能点、所属阶段(如
P1、P2)、阶段内篇号、标题和仅含 ASCII 小写字符的短横线式别名。 - 以
assets/article-template.md为写作骨架。替换所有占位内容并删除模板说明。 - 如果
blog/不存在则创建它。除非用户明确要求修改已有文章,否则只新建一个.md文件。 - 检查元信息、文件名、永久链接、
<!-- more -->、事实陈述、代码片段和 Git 差异。除非用户明确要求,否则不要创建提交。
事实依据
- 将源代码、测试和实际差异视为事实依据;使用文档和提交信息理解设计意图与背景。
- 只描述选定变更已经体现的行为。明确标注计划和未来工作,不得将其写成已经实现的能力。
- 不得虚构调试经历、性能数据、设计争论、执行命令、命令输出或用户反馈。
- 优先选用能够揭示核心思路的短代码片段。确保片段与仓库内容一致,并在附近正文中注明仓库相对路径。
- 如果目标提交主要是脚手架、配置或文档,应解释这项基础工作的目的和后续价值,但不得夸大现有能力。
文件名与元信息
文件名使用 2026-PX-0X-xxx.md 格式:
- 除非用户修改约定,否则本系列固定使用四位年份
2026。 - 将
PX替换为路线图阶段,例如P1。 - 将
0X替换为该阶段内的两位文章序号,从01开始。 - 将
xxx替换为描述该功能的简短英文别名,只使用小写 ASCII 字母、数字和短横线。 - 示例:
2026-P1-03-streaming-chat.md。 - 根据已有文章推断下一个未使用的序号。如果无法可靠判断所属阶段,应暂停并询问用户,不要自行猜测。
- 不得覆盖已有文件。如果目标名称已经存在,先判断它是否对应同一功能;否则递增序号。
严格使用以下元信息结构:
---
title: 【Agent进阶专题】中文标题
tags: [AI, Agent]
categories:
- AI
date: YYYY-MM-DD HH:mm:ss
permalink: /agent/YYYY/MM/slug/
---
- 新建文件时使用当前本地日期和时间。
- 标题应具体并体现结果,不使用章节编号,也不要使用“一些思考”之类含糊标题。
- 文件名和永久链接使用相同的英文别名。
- 永久链接中的
YYYY/MM从date推导。
文章固定结构
保持以下三部分顺序:
- Hexo 元信息。
- 位于
<!-- more -->之前的简洁简介,用于列表页摘要。 - 位于
<!-- more -->之后的完整正文。
使用自然且能够说明内容的标题,不要直接使用“简介部分”或“正文部分”等模板化标题。简介由一至两个短段落组成,需要说明问题、此次交付的能力及其价值。
正文应围绕具体功能组织,不要机械套用完全相同的标题。根据主题只选择必要内容,不要求每篇全部覆盖:
-
变更前存在的问题或限制;
-
当前小功能点的目标与边界;
-
核心设计或理解模型;
-
配合精选代码片段说明实现路径;
-
验证方式与可观察结果;
-
取舍、当前限制和下一项自然演进能力;
-
用简短结语将本篇内容连接到整个系列的演进主线。
-
导读、概念介绍和设计点题类文章建议控制在 1000 个中文字符左右;这是保持简洁的参考值,不是硬性上限。根据章节范围和必要信息调整篇幅,优先保证主题讲清且没有无关扩展。
-
标题给出的主题就是内容边界。只讲清当前主题,不借机扩展相关协议、实现细节或远期能力。
读者视角与系列衔接
- 面向第一次接触本项目的外部读者写作,不要把作者已经掌握的项目背景当作读者常识。
- 阶段编号和文章编号用于组织系列,不是正文的叙事前提。首次出现
P0、P1等编号时必须用自然语言解释其含义;如果编号对理解当前内容没有帮助,就不要在正文中使用。 - 每篇文章先从读者能够理解的场景、问题或一次自然的需求变化切入,再逐步引出项目术语和设计结论。
- 用“原本有什么—遇到什么问题—做出什么选择”推进文章,但不要为了讲故事虚构场景或增加文学化铺垫。
- 不得使用“如前所述”“大家已经知道”等措辞假设读者读过其他文章。即使文章位于系列中间,也应提供理解当前主题所需的最少背景。
- 相邻文章应各守边界,避免提前讲完后续主题。结尾只需自然提出下一篇的问题,不要罗列尚未解释的阶段和术语。
- 当前导读部分暂定为:
P0-00项目介绍与目录导航、P0-01架构设计、P0-02功能划分、P0-03阶段规划、P0-04目录规划。创作其中一篇时,不要侵占其他篇目的主要内容。
系列文风
- 使用清晰的简体中文,面向理解 TypeScript 和基本 LLM 概念、但可能刚接触 Agent 工程的开发者。
- 直接、口语化、克制。先给结论,再补必要原因;能用一句话说清的内容不要扩成一段。
- 删除不推动观点的过渡句、重复总结、设问和修饰语。每个段落只表达一个重点,通常不超过三句话。
- 优先使用具体动词和短句,避免“我们需要先回答一个不那么显眼、却会影响整个项目的问题”一类绕弯表达。
- 适度使用“我们”营造共同实践感,重点仍应放在技术推理和可复现的工程过程上。
- 按照“动机—原理—实现—验证”的顺序展开。在进入密集实现细节前,先解释为什么这样做。
- 保持段落简短、标题明确,并与项目文档使用一致的术语。
- 技术术语首次出现时给出简要解释。代码中的英文标识符保持原样;不要为同一概念反复更换译名。
- 避免营销语言、泛泛的 AI 背景介绍、夸张结论、填充式总结和流水账式叙述。
- 每篇文章都应能够独立阅读,同时在概念上承接前一项能力并引出下一项能力。
- 用最短的具体情境引出矛盾和选择,避免从项目内部术语或文档摘要直接起笔,也避免把技术文章写成散文。
- 不为追求完整而增加章节。点题类文章通常使用两至四个短章节即可。
Markdown 与代码
- 使用标准 Markdown,围栏代码块必须标注语言。
- 正文标题从
##开始;页面标题由 Hexo 元信息提供,不要在正文中重复一级标题。 - 标题、列表、代码块和
<!-- more -->前后保留空行。 - 代码片段应尽量短且与主题直接相关。只有在省略范围明显且不会造成误解时才使用
...。 - 展示命令时,应区分命令和示例输出。只有命令确实存在或实际执行过,才能将其作为验证命令写入文章。
- 除非用户明确要求,否则不要添加目录。
最终检查
回复用户前确认:
- 只新增或修改了一篇目标 Markdown 文章。
- 文件名符合
^2026-P[0-9]+-[0-9]{2}-[a-z0-9]+(?:-[a-z0-9]+)*\.md$。 - 元信息结构有效;除非用户要求,否则只包含本系列规定的字段。
- 有意义的简介之后恰好出现一次
<!-- more -->。 - 没有遗留任何占位内容。
- 事实陈述和代码片段符合当前仓库状态。
- 最终回复包含文章文件链接,并用一句话说明文章主题。