Trang này chứa thông tin chi tiết về một dự án viết nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Hệ sinh thái ARK
- Người viết nội dung kỹ thuật:
- yslcrypto
- Tên dự án:
- Dự án 1 – Làm quen với Hướng dẫn phát triển Core Blockchain
- Độ dài dự án:
- Thời hạn tiêu chuẩn (3 tháng)
Mô tả dự án
Sau đây là một số ý kiến sau khi đọc qua phần Bắt đầu:
CÁCH THIẾT LẬP MÔI TRƯỜNG PHÁT TRIỂN CỦA BẠN
Cài đặt: Tôi sẽ tìm hiểu sâu hơn về cách cài đặt các công cụ phát triển tại đây. Tôi sẽ cung cấp các mã mẫu, cùng với các lỗi thường gặp và cách khắc phục (chúng ta có thể liên kết đến một trang khắc phục sự cố tại đây).
Khởi động mạng thử nghiệm đầu tiên: Ấn tượng ban đầu: hiện tại, việc này khá khó hiểu đối với những người chỉ lướt qua và muốn thiết lập nhanh. Dưới đây là một số điều tôi sẽ thay đổi:
Tôi sẽ xem xét định nghĩa ngay cả những khái niệm cơ bản như testnet.
Tôi sẽ cung cấp các mã mẫu ngắn hơn: mkdir, cd, v.v. Tôi cũng nhóm các mã này lại với nhau để người đọc có thể sao chép và dán dễ dàng hơn. Không có gì quá đơn giản và mọi người đều thích sao chép và dán.
Khi đọc lần đầu, tôi không rõ bước 1 và 2 của tiểu mục khởi động mạng đạt được điều gì. Bạn phải suy nghĩ quá nhiều khi nhấp và xem các đường liên kết. Tôi nghĩ chúng ta có thể làm rõ vấn đề này mà không cần đi sâu vào chi tiết.
Ít nhất, tôi sẽ cung cấp thông tin tổng quan cấp cao về core-container ở bước 5 (tôi nghĩ thực sự là bước 4?) để người đọc có thể hiểu được những gì họ đang làm mà không cần theo dõi đường liên kết.
Đối với bước 3 và 5 (thực sự là bước 4), tôi sẽ giải thích các đoạn mã dài hơn.
Ở bước cuối cùng, tôi sẽ liên kết đến trình bổ trợ và tệp đã cài đặt để giúp người đọc dễ dàng hơn.
Cuối cùng, tôi sẽ chỉnh sửa theo cách đảm bảo rằng không có quá một ý tưởng trong mỗi đoạn (cho phép đọc lướt dễ dàng). Tôi cũng sẽ làm cho giọng điệu vui nhộn / thân thiện hơn một chút và thêm một vài biểu tượng cảm xúc.
CÁCH THEO DÕI CHUỖI ĐƯỜNG KÉP
Tôi sẽ đơn giản hoá đoạn đầu tiên. Tôi sẽ giải thích về trình bổ trợ, trình uỷ quyền làm gì (hoặc ít nhất là liên kết đến nội dung giải thích về nguyên tắc đầu tiên), ý nghĩa của việc tạo khối và đưa ra ví dụ về một sự kiện mạng.
Xác định vấn đề: Tôi sẽ cung cấp cho người đọc thông tin trực quan về nút đầy đủ, đường liên kết đến nội dung giải thích chi tiết hơn và giải thích rõ hơn về sự đánh đổi giữa nút đầy đủ và ứng dụng bên ngoài. Cuối cùng, tôi sẽ liên kết đến trang bắt đầu trước đó – cách thiết lập môi trường phát triển và mạng thử nghiệm đang hoạt động – ở cuối tiểu mục này (trong trường hợp người đọc đã bắt gặp trang này trước tiên).
API sự kiện: Không rõ ràng – từ danh sách các sự kiện hiện có – rằng chúng ta nên sử dụng ‘block.applied’ để nhận được những gì chúng ta muốn. Mặc dù Mẹo bên dưới sẽ giúp bạn hiểu rõ hơn, nhưng tôi muốn giải thích trước.
Tôi không rõ ‘block.apply’ trả về giá trị gì. Tôi nghĩ điều quan trọng là phải làm rõ vấn đề này.
Trong ví dụ về mã ở phần cuối, tôi nghĩ sẽ giúp làm rõ rằng 'block.generatorPublicKey' sẽ thay thế 'block.forger' (trong ví dụ về mã giả trước đó) và 'DispatcherKey' thay thế 'uỷ nhiệmWeAreMonitoring'. Cuối cùng, để đảm bảo các mẫu mã và mã giả nhất quán, tôi cũng sẽ hoán đổi 'DelegateKey' và 'generatorKey' trong câu lệnh if.
Tạo trình bổ trợ: Tôi sẽ giải thích ý nghĩa của scaffolding (giàn giáo) trong ngữ cảnh này. Ví dụ: Giống như giàn giáo thực tế tại một công trường xây dựng, khi nói đến giàn giáo trong ngữ cảnh này, chúng tôi muốn nói đến một cấu trúc tạo sẵn đơn giản cho trình bổ trợ của bạn, trên đó bạn có thể xây dựng cấu trúc thực tế.
Tôi sẽ thêm các mã mẫu để đổi tên thư mục và trình bổ trợ, hiển thị ví dụ về package.json và giải thích ý nghĩa của việc "thêm cấu hình cần thiết" vào plugin.js.
Tổng kết: Tôi sẽ làm rõ hơn về những thay đổi này. Và kết thúc bằng lời chúc mừng cùng vài biểu tượng cảm xúc khác :)
CÁCH GỬI GIAO DỊCH ĐẦU TIÊN BẰNG ARK SDK
Bắt đầu: Tôi sẽ thêm một mã mẫu để cho phép người dùng tạo một thư mục mới bằng cách sao chép và dán.
Kết nối với Testnet: Tôi sẽ giải thích REST API là gì, phòng trường hợp người đọc không quen thuộc (hoặc ít nhất là liên kết đến nội dung giải thích). Tôi sẽ cung cấp và liên kết đến một ví dụ về Trình xem JSON. Tôi sẽ sử dụng giọng điệu thân thiện hơn trong MẸO thứ hai (vì chúng ta đang yêu cầu người đọc giúp đỡ).
Thay đổi Trình quản lý cấu hình: Tôi sẽ đề cập đến các ví dụ phổ biến về lỗi liên quan đến mạng và cân nhắc việc liên kết đến phần khắc phục sự cố.
Thiết lập tài khoản gửi và nhận: Tôi sẽ thêm mã mẫu để cho phép người đọc thay đổi sang thư mục cấu hình bằng tính năng sao chép và dán. Tôi sẽ thêm một mã mẫu cho thấy nội dung của delegates.json.
CÁCH GỬI GIAO DỊCH BẰNG CLI TESTER ARK CORE
Điều kiện tiên quyết: Tôi sẽ thêm một mã mẫu cho biết cách lấy một bản sao đang hoạt động của kho lưu trữ GitHub ARK Core và một mã mẫu khác để di chuyển trình đọc vào thư mục phù hợp.
Kiến thức cơ bản: Tôi sẽ làm rõ đoạn đầu tiên cho những người không quen với các biến môi trường đường dẫn.
KẾT LUẬN
Tóm lại, đây chỉ là một số ghi chú ngắn gọn mà tôi ghi lại khi đọc tài liệu. Khi chúng ta cùng bắt đầu dự án, tôi muốn tự mình trải qua quy trình này để xem mình gặp khó khăn ở đâu. Và sử dụng kiến thức đó để đơn giản hoá thêm tài liệu.
Cuối cùng, mặc dù tôi chỉ mới thực hiện một dự án ở đây, nhưng tôi thấy quá trình này thường mất nhiều tuần. Như đã thảo luận trong thư từ trao đổi của chúng ta, tôi nghĩ chúng ta có thể làm việc trên một số dự án trong thời gian hợp tác.