文档目录01 / 16

开始使用01 / 16

认识 Noea Code

本页内容

Noea Code(下文简称 Noea)帮助你在使用 AI 编写软件时,理解并决定软件的行为。你写下要求,由编程智能体(Agent)修改代码,再结合实现说明、依据和关注事项,检查软件是否符合预期。

你可以从已有项目的一条规则开始。产品行为、架构约束、算法要求,都可以成为第一条意图。

这些希望软件持续满足的要求,就是“意图”。功能完成后,意图仍然有效;想改变行为时,再修改对应的文字。你不必描述整个软件,先写清自己关心的部分即可。

意图与实现如何联系

假设你正在开发一个打卡应用,写下了这样的要求:

连续打卡满 7 天,给用户一个奖励。

这句话明确了奖励的条件,却没有规定如何计算一天、漏打后怎么办,以及奖励采用什么形式。Agent 实现时仍然需要作出这些选择。

Noea 将这句话与实现说明联系起来。你可以阅读当前代码如何累计天数,查看支持说明的代码位置或测试材料,也可以发现尚未满足的要求和值得讨论的选择。如果你决定“一天按用户所在地的自然日计算”,就把这项决定补进意图,作为后续实现的依据。

先认识三类内容

内容用来做什么在哪里查看
意图文档留下你要求软件满足的行为与约束侧栏的“意图”,文件后缀为 .noea.md
实现软件的代码、配置以及相关实现文件项目关联的实现文件夹
实现说明解释当前实现如何回应某段意图,并提供依据与关注事项意图文档的旁注

意图文档使用 Markdown 格式,可以用 Git 管理,也能用其他编辑器维护。实现说明由 Noea 另外保存,显示在正文旁边的“旁注”中。

一次日常工作怎样进行

  1. 明确意图。 直接写文档,或先和 Agent 讨论,再审阅它提出的文字变更。
  2. 推进并理解实现。 让 Agent 工作,随后调查实现,阅读说明、依据和关注事项。
  3. 写回决定。 针对具体段落追问,把决定长期保留的要求写进意图,再继续实现和检查。

如果代码已经存在,可以先写出你要检查的要求,再运行“解释”。如果要求还需要实现,可以通过对话或“实现”操作推进。

你可以接受一个已经理解的实现选择,不必把所有细节都变成长期要求。哪些选择值得写回文档,见阅读实现说明与证据。

Noea 与 Agent 的分工

Noea 提供写文档、讨论、审阅变更和查看实现说明的工作台;Agent 负责读取项目、调用工具和修改代码。你可以选择应用支持的 Agent,并使用它提供的模型与登录方式。界面中的“智能体”指的就是 Agent。

在 Noea 的提议流程中,Agent 对正式意图的变更需要你作出决定。你可以修改提议后接受,也可以忽略。代码修改、运行命令等操作则受当前 Agent 的能力和权限设置影响。

实现说明不能代替测试或实际使用。对重要行为,仍应检查相关依据,并按需要验证。

从最在意的一部分开始

第一次使用时,选择一个范围小、结果容易检查的问题,例如奖励何时发放、库存不足如何处理,或某个接口必须遵守的约束。其余部分可以继续沿用你现有的开发方式。

接下来先完成安装与准备,再跟随第一次工作流走完一个例子。