本页详细介绍了 Google 文档季收录的技术文案项目。
项目摘要
- 开源组织：
- ARK 生态系统
- 技术文档工程师：
- yslcrypto
- 项目名称：
- 项目 1 - 核心区块链开发指南入门
- 项目时长：
- 标准时长（3 个月）
Project description
阅读“开始使用”部分后，我有以下几点想法：
如何设置开发环境
安装： 我会在此详细介绍如何安装开发工具。我会提供代码示例，以及常见错误和解决方法（我们可以在此处链接到问题排查页面）。
启动您的第一个测试网络： 第一印象：目前，对于仅浏览并希望快速完成设置的用户来说，这非常令人困惑。以下是我建议您改进的地方：
我可以考虑像定义测试网络这样的基本概念。
我会提供更简短的代码示例：mkdir、cd 等。此外，我还会将它们归为一组，以便读者更轻松地复制和粘贴。没有什么事都不容易，他们都喜欢复制和粘贴。
初次阅读时，我对网络启动子部分的第 1 步和第 2 步的实现不甚了解。点击和浏览链接需要花很多心思。我想我们可以不必深入探究，就让这件事更加清晰明了。
我至少会在第 5 步（我认为实际上是第 4 步）中简要介绍 core-container，以便读者在不点击链接的情况下对自己在做什么有一定的直观了解。
对于第 3 步和第 5 步（实际上是第 4 步），我会解释较长的代码示例。
在最后一步中，我会链接到已安装的插件和文件，以方便读者使用。
最后，我会进行编辑，确保每个段落不超过一条创意（以便于浏览）。我还会让措辞更有趣 / 更友好，并添加一些表情符号。
如何监控区块链
我会简化第一段。我会解释插件是什么、代理的用途（或者至少提供指向从第一性原理进行解释的链接）、伪造分块的含义，并举例说明网络事件。
明确问题：我希望让读者直观地了解完整节点是什么，链接到更详细的说明，以及更好地说明完整节点和外部应用之间的权衡。最后，我会在本子部分的末尾提供指向上一个入门页面（介绍如何设置可用的测试网络和开发环境）的链接（以防读者先看到本页）。
Events API： 在可用事件列表中，我们不清楚应该使用“block.applied”获取所需的结果。虽然下面的提示会更清楚地说明这一点，但我还是先解释一下。
我不清楚“block.applied”会返回什么。我认为，请务必明确这一点。
在结尾的代码示例中，我认为最好明确说明“block.generatorPublicKey”取代了“block.forger”（在前面的伪代码示例中），并且“delegateKey”取代了“delegateWeAreMonitoring”。最后，为了确保代码和伪代码示例保持一致，我还会在 if 语句中交换“delegateKey”和“generatorKey”。
创建插件： 我会解释在此上下文中“脚手架”的含义。类似如下：就像建筑工地上的真实脚手架一样，在本上下文中，我们所说的脚手架是指为您的插件预先构建的简单结构，您可以在其上构建真实的结构。
我会添加重命名目录和插件的代码示例，展示 package.json 示例，并说明“向 plugin.js 添加必要的配置”的含义。
总结一下：我会更清楚地说明具体有哪些变化。最后，以祝贺结尾和更多表情符号 :)
如何使用 ARK SDK 发送首笔交易
开始：我会添加一个代码示例，以允许用户通过复制和粘贴创建新目录。
连接到 Testnet：我会解释什么是 REST API，以防读者不熟悉（或者至少提供一个解释链接）。我会提供一个 JSON 查看器示例，并提供该示例的链接。我会在第二个提示中使用更友好的语气（因为我们在请求读者提供帮助）。
更改配置管理器：我会提及与网络相关的常见 bug 示例，并考虑链接到问题排查部分。
设置发送和接收账号： 我会添加一个代码示例，让读者可以通过复制粘贴切换到配置目录。我会添加一个代码示例，展示 delegates.json 的内容。
如何使用 ArK Core 的 Tester CLI 发送交易
前提条件：我会添加一个代码示例，展示如何获取 ARK Core GitHub 代码库的有效副本，以及另一个代码示例，用于将读取器移至正确的目录。
基础知识：为不熟悉路径环境变量的用户，我会让第一段更清晰。
总结
最后，这些只是我在阅读文档时做的一些简短笔记。在我们一起着手处理此项目时，我想亲自完成整个流程，看看自己在哪些方面出了问题。并利用这些知识进一步简化文档。
最后，虽然我只处理了一个项目，但我认为整个过程不会超过几周时间。正如我们在电子邮件通信中所讨论的，我认为在我们的时间里可以同时开展多个项目。