本頁將詳細說明 Google Season of Docs 接受的技術文件寫作專案。
專案摘要
- 開放原始碼組織：
- ARK 生態系統
- 技術撰稿人：
- yslcrypto
- 專案名稱：
- 專案 1 - 區塊鏈核心開發指南入門
- 專案長度：
- 標準長度 (3 個月)
Project description
閱讀完「開始使用」一節後，我有一些想法：
如何設定開發環境
安裝：我會進一步說明如何安裝開發工具。我會提供程式碼範例，以及常見錯誤和修正方法 (我們可以在這裡連結至疑難排解頁面)。
啟動第一個 TestNet： 第一印象：對於只想快速完成設定的使用者來說，目前的操作方式相當混亂。以下是我想變更的部分內容：
我甚至會考慮定義測試網絡等基本概念。
我會提供更多較短的程式碼範例：mkdir、cd 等。我也會將這些程式碼範例分組，方便讀者複製貼上。製作起來很簡單，而且人人都喜歡複製及貼上。
初次閱讀時，我對網路啟動子區段的步驟 1 和 2 無法理解。點選並瀏覽連結需要花費太多心思。我覺得應該可以清楚地達成這個目標，不用過度摸索雜草。
我至少會在步驟 5 (我認為其實是步驟 4) 中提供核心容器的概略說明，讓讀者不必點選連結，也能瞭解他們在做什麼。
針對步驟 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 檢視器的範例和連結。我會在第二個提示中使用較友善的語氣 (因為我們是向讀者提出要求)。
變更 Config Manager： 我會列舉一些網路相關錯誤的常見範例，並考慮連結至疑難排解專區。
設定傳送和接收帳戶： 我會新增程式碼範例，讓讀者透過複製貼上的方式變更至設定目錄。我會新增程式碼範例，顯示 delegates.json 的內容。
如何使用 ARK Core Tester CLI 傳送交易
先決條件： 我會新增程式碼範例，說明如何取得 ARK Core GitHub 存放區的實際副本，以及如何將讀取器移至正確的目錄。
基本概念：為了讓不熟悉路徑環境變數的使用者更容易理解，我會將第一段內容寫得更清楚。
結論
總結來說，這些只是我在閱讀說明文件時記下的簡短筆記。展開這項專案時，會想自行完成流程，瞭解我的表現如何。並運用這些知識進一步簡化文件。
最後，雖然我只有完成一項專案，但過了幾週才會看到這個成果。如同我們在電子郵件往來中討論的，我認為我們可以在這段時間內一起處理多個專案。