单位 8 / 11

文档和技术写作:白皮书、NatSpec 和用户指南

收益:

  • 能够安全地使用人工智能来制作白皮书、NatSpec、技术简单的翻译和风险披露,并了解这是最富有成效的领域。
  • 能够用实际代码验证每项技术声明,并消除夸大和保证语言,以避免文档不正确的风险
  • 能够诚实地接受风险,“非财务建议”警告和文档代码一致性

Web3 中的文档不是奢侈品,而是安全和信任的问题。通过与智能合约交互,用户将拿自己的真实资金冒险;如果他不明白自己在做什么,他就很容易被欺骗。审计员无法安全地审查没有详细记录的代码。在本单元中,我们涵盖人工智能最可靠和最高效的领域:文档和技术写作。从白皮书到代码内评论,从用户指南到风险披露,人工智能在这里是一个真正的力量倍增器——只要对准确性进行人道监控。

Web3 文档的类型

  • 白皮书/litepaper:描述项目愿景、机制和代币经济的基本文件。
  • 技术文档:合约接口、开发人员集成指南。
  • NatSpec(以太坊自然语言规范 - Solidity 中的标准代码内注释格式,描述函数的功能):嵌入代码中的文档,可供人类和工具阅读。
  • 用户指南:纯文本告诉最终用户“如何使用,存在哪些风险”。
  • 免责声明:法律和道德上要求的警告。

这些类型的一个常见问题是:开发人员不喜欢编写,并且经常把它留到最后一刻。人工智能恰好填补了这一空白。

为什么文档是人工智能最安全的领域

文档中错误的成本低于审计中的错误:纠正一个错误的句子,但不会(直接)赚到钱。此外,人工智能在语言生成方面天生就很强大。所以人工智能在这里既高效又相对安全。但仍然存在两个关键风险:

  1. 虚假技术声明:人工智能可能会歪曲代码的作用;这会误导用户,并可能成为安全漏洞(除非它说“此功能可以保护您的资金”,但实际上却没有)。
  2. 夸张/营销语言:人工智能可以产生使项目看起来安全或有利可图的语言;这既是一个道德问题,也是一个法律问题。
注意:文档描述了代码;这不是代码本身。人工智能编写的每一个技术断言(“发生这种情况”、“维持这种情况”)都必须根据实际代码进行验证。不正确的文档可能比正确的代码更危险,因为用户信任文档。

在文档中使用人工智能的层次

1. 国家规范生成。 AI 读取现有函数并起草 NatSpec 解释:它做什么、它的参数是什么、它返回什么。这简化了检查和维护。

2.技术-简单翻译。人工智能将复杂的机制翻译成最终用户可以理解的语言——这是 Web3 的最大需求之一。

3. 白皮书大纲和结构。人工智能生成白皮书的框架和部分;内容准确性是人类的。

4. 多语言和级别调整。人工智能可以用土耳其语和英语生成相同的技术内容和简单内容。

弱提示/强提示

弱提示:

为该项目撰写白皮书。

人工智能在不了解实际机制的情况下编造了夸大的、可能是虚假的、充满营销的文案。

强力提示:

您的角色:Web3 技术作家。以下是该项目的真实机制、代币经济学和代码。仅根据此信息撰写白皮书草稿。规则:- 不要夸大其词,不要使用“保证利润”、“完全安全”等短语。- 每个技术主张都以我给出的机制为基础;不要添加捏造内容。- 添加明确说明风险的“风险”部分。- 添加警告“这不是财务建议。”将您不确定或我没有的任何信息标记为[待填写]。

四个可复制模板

1) NatSpec生成:

将标准 NatSpec 注释写入以下函数:@notice(做什么,简单)、@dev(技术说明)、@param 和 @return。只写代码实际做的事情;添加代码中没有的行为。标记您不确定的效果。

2)技术简单翻译:

用简单的土耳其语解释这个机制,让加密货币新手用户能够理解:它是做什么的,用户应该做什么,有什么风险?夸张;没有安全保证。不要隐藏风险,而是将风险暴露出来。

3) 风险/警告部分:

为该项目写一个诚实的“风险和警告”部分:智能合约风险、市场风险、流动性风险、监管不确定性、关键损失。用通俗易懂的语言解释每项风险。不要低估风险;以“这不是财务建议”结尾。

4)文档-代码一致性检查:

下面是一个函数及其可用文档。标记文档与代码的实际行为相矛盾或忽略的地方。最终决策;提交以供“开发者验证”。

三个迷你箱(数量)

案例1——NatSpec加强检查。一个团队提交了一份包含 25 个功能的合同供审查,但没有发表评论;审计员要求额外的时间来理解逻辑。该团队使用 AI 制作了 NatSpec 草案,并用代码确认了每一份草案;审核准备时间缩短了近 1 天。教训:良好的文档可以降低审计成本。

案例 2——虚假陈述被抓获。 YZ制作的用户手册上写着“您的资金可能随时被提取”;而合同中有 7 天的锁定期。技术审查发现了这一点。如果它被发布,用户就会被误认为是受害者。教训:每项技术声明都由代码确认。

案例 3——夸大事实得到澄清。在第一份白皮书草案中,AI使用了“高回报、无风险”等表述。该团队删除了这些内容并添加了诚实的风险部分。这在道德和法律上都保护了该项目。教训:人工智能的营销偏见必须受到审计。

记录的道德负担

Web3 文档是在用户冒着金钱风险的背景下阅读的。因此:

  • 诚实:不能隐藏风险,不能做出夸大的承诺。
  • 准确性:技术声明必须与代码相符; “文件是这么说的”并不是辩护,而是歪曲事实。
  • 可访问性:用用户真正理解的语言编写是一种安全措施;一份不被理解的文件就会招致欺骗。
  • 免责声明:需要明确说明的是,这不是财务建议和监管不确定性。
提示:Web3文档的诚实性测试:“如果用户投入金钱只信任这份文档,那么面对真相时他会感到被欺骗吗?”始终让人工智能突出显示风险部分,而不是在最后将其掩埋。

常见错误

  • 没有用代码确认技术声明。错误的文档会误导用户。
  • 放弃炒作/营销语言。道德和法律风险。
  • 最小化或隐藏风险。违反信任。
  • 打印白皮书而不向人工智能提供真正的机制。它生产制造品。
  • 忽略“非财务建议”警告。法律义务。
  • 没有使文档与代码保持同步。当代码更改时,文档就会产生误导。

综上所述

  • 文档是 Web3 中的安全性和信任问题;这是人工智能最富有成效的领域。
  • 错误的成本相对较低,但虚假的技术声明和夸大其词是严重的风险。
  • 每一项技术主张都必须经过真实代码的确认;该文档不会替代代码。
  • 风险应诚实且显着地书写;应删除夸大和保证的语言。
  • “这不是财务建议”,监管警告是强制性的。

应用任务

获得智能合约功能。给 AI 提示“生成 NatSpec”,并将生成的解释逐行与代码的实际行为进行比较——是否有任何分歧?然后为相同的功能生成“技术简单翻译”和“风险/警告部分”。找到并纠正至少一项夸大或与代码相矛盾的 AI 语句。

清单

  • [ ] 我用实际代码确认了每一项技术主张。
  • [ ] 我删除了夸大/保证。
  • [ ] 我诚实地写下了风险并强调了它们。
  • [ ]我给了AI真实的机制;我没让他弥补。
  • [ ] 我添加了警告“这不是财务建议。”
  • [ ] 我为车辆和控制完整地编写了 NatSpec。
  • [ ] 我计划使文档与代码保持同步。