返回广场
方法与工具 当前可用

构建记录怎么写?一份能直接套用的四段式模板

8 次浏览

构建记录写成四段就够:问题、工具、结果、下一步,再附代码、提示词、验证状态。本文给出每段该写什么、反例与判断标准,以及发布前 6 条自检清单和一份可直接照抄的最小示例。

未验证

方法说明

构建记录写成四段就够:问题、工具、结果、下一步。每段两三句,再附三样证据——代码、提示词、验证状态。

下面是可以直接抄的模板,每一段都标了反例和判断标准。

构建记录模板总览:四段正文,三个附件

正文四段回答四个问题:想解决什么、用了什么、现在到哪、下一步做什么。

三个附件负责让人相信你:一段能跑的代码、一条起作用的提示词、一个明确的验证状态。

为什么是四段而不是更多?因为读完一条记录的人会按顺序问这四个问题。多一段,就有人跳过;少一段,就有人要私信问你。

这四段是怎么来的,项目为什么会废那篇从三个断点推过一遍,先看懂那段,填起来会更快。

构建记录不必写得像报告。它要解决的是「半年后还能不能接着做」,不是「证明我这周很忙」。

正文加起来通常 200 到 600 字。写不满,说明还没想清楚;写超了,通常是混进了不相关的过程叙述。

第一段:问题

该写什么:要解决的具体问题、边界、什么不在这版范围内。

反例:「做一个 AI 工具,提升效率。」没有对象、没有边界、没有不做什么。

判断标准:换个人读这段,能不能说出「所以你不做什么」。说不出来,就是没收敛。

另一个检查法:数一数这段话里有几个形容词。超过两个,删掉重写。

第二段:工具

该写什么:用了哪些模型、框架、服务,以及卡在哪一步。版本号写你实际用的那个,记不清就写「以官方文档为准」。

反例:罗列十个工具名,不说哪个起了作用。

判断标准:读者能不能据此判断「我手上这套能不能做同样的事」。

同一件事有几个工具可选时,写清你为什么选这个。这一句往往是别人最想看的,也是最容易被省掉的。

第三段:结果

该写什么:现在能做到什么,哪部分通,哪部分只是看起来通。

反例:「基本完成了,效果不错。」这是自我评价,不是结果。

判断标准:每条结果能否对应一个当场能做的动作。能截图就截图,截图比形容词省字。

第四段:下一步

该写什么:接下来做什么,当前卡在哪,需要什么样的帮助。

反例:「继续优化。」

判断标准:下一个人(或下周的你)拿到这句,能不能直接开工。卡点要具体——报什么错、在哪一步、试过什么没用。「不太顺」等于没写。

代码怎么放

放最小可运行片段,不贴整个仓库。一段说明关键做法的函数、一个配置块、一段调用示例,够了。其余用仓库链接或文件路径指过去。

比如你要说明「不改数据结构怎么做出筛选」,贴那个过滤函数就够,不必把整个页面组件搬上来。

判断标准:这段代码单独拿出来,能不能讲清「关键那一步是怎么做的」。不能,就换一段。

提示词怎么留

留两样:原始版本,和改动原因。

原始版本要能看出当时的约束——只改这个函数、不要引入新依赖、返回结构保持原样。改动原因写一句,例如「它第一次重写了整个文件,补上『不要新增依赖』之后才只动局部」。

只留最终版提示词,等于把最有用的部分删了:你留下了答案,扔了为什么需要这个答案。

如果你还没建立「先写验收再动手」的习惯,从需求到上线那五步值得先过一遍,提示词才有地方落。

验证状态怎么标

在造个啥发布时能选三种验证状态:未验证、作者已验证、社区已验证。判断标准很硬——你有没有亲手按自己写的条件走过一遍。

  • 走过,结果符合:作者已验证
  • 别人照这条记录复现成功:社区已验证
  • 只跑起来、没验过边界:未验证

另有一套构建状态:计划中、构建中、当前卡点、当前可用、需要重新验证、已归档。验证状态说的是「这条结论可不可信」,构建状态说的是「这个项目现在什么情况」。两个都标,别混着用一个。

验证状态是整条记录里唯一能让人判断可信度的字段。写错这一项,前面四段写得再好也会被当成自夸。

依赖换了版本、接口改了字段之后,把那条改成「需要重新验证」。这不是退步,是准确。

三种不合格的构建记录

只有结论:写了「用了 A 方案,可行」,没写它解决了什么、验证到什么程度。这种记录别人用不上。

只有过程:写了三天里试了多少东西,到头没给结论。读的人加班看完,还是要自己试一遍。

只有截图:界面很好看,看不出怎么做的。截图可以做附件,不能当正文。

这三种都算构建记录,但都不能用。区别只在于:它们省掉的,正好是别人唯一想拿走的东西。

发布前 6 条自检

  1. 问题那段有没有写「不做什么」
  2. 每个工具名后面有没有跟一句它解决了什么
  3. 结果里有没有区分已验证和没验证
  4. 代码片段能不能单独看懂
  5. 提示词是不是原始版本,有没有写改动原因
  6. 下一步是不是一句可执行的话

六条全过再发。过不了第 3 条,先别改文案,回去补测试。

自检花不了十分钟,它挡住的是最常见的那种记录:读起来很顺,读完什么也没留下。

模板之外

模板的意义是让你少想格式,多想判断。

造个啥的发布页把目标、工具、关键步骤、已知限制分开收,正文按这四段展开,填完就能发。想先看成品长什么样,去广场挑几条标着「社区已验证」的读一遍;同方向的记录在方法与工具里更集中。

模板用几次之后你会发现,写的时候最费劲的那一段,往往就是当时最没想清楚的那一步。

复现清单

按构建步骤逐项勾选,进度只保存在本机浏览器。

0 / 3
还没勾选

社区讨论 0 条观点

还没有观点 写下第一条观点。