หน้านี้มีรายละเอียดโครงการงานเขียนเชิงเทคนิคที่ได้รับการยอมรับใน Google Season of เอกสาร
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- ระบบนิเวศ ARK
- นักเขียนเชิงเทคนิค
- Yslcrypto
- ชื่อโปรเจ็กต์:
- โปรเจ็กต์ 1 - การเริ่มต้นใช้งานตามคู่มือการพัฒนาบล็อกเชนหลัก
- ความยาวของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
ลองมาดูตัวอย่างความคิดหลังจากอ่านในส่วนเริ่มต้นใช้งานแล้วกัน
วิธีตั้งค่าสภาพแวดล้อมสำหรับนักพัฒนาซอฟต์แวร์
การติดตั้ง: เราจะอธิบายวิธีติดตั้งเครื่องมือสำหรับนักพัฒนาซอฟต์แวร์อย่างละเอียดที่นี่ เราจะแสดงตัวอย่างโค้ด รวมถึงข้อผิดพลาดที่พบบ่อยและวิธีแก้ไข (เราอาจลิงก์ไปยังหน้าการแก้ปัญหาที่นี่)
การเริ่มต้นใช้งาน Testnet แรกของคุณ: ความประทับใจแรก: ตอนนี้ค่อนข้างสับสนสำหรับคนที่แค่เลื่อนดูคำสั่ง และต้องการตั้งค่าอย่างรวดเร็ว สิ่งที่เราอยากเปลี่ยนแปลงมีดังนี้
เราอาจพิจารณากำหนดคำศัพท์พื้นฐานอย่างเทสต์เน็ตด้วย
ฉันจะใส่ตัวอย่างโค้ดที่สั้นลง เช่น mkdir, cd เป็นต้น และจัดกลุ่มไว้ด้วยกันเพื่อให้ผู้อ่านคัดลอกและวางได้ง่ายขึ้น ทุกอย่างต้องไม่ง่ายจนเกินไป และทุกคนชอบคัดลอกและวาง
เมื่ออ่านครั้งแรก เรายังไม่แน่ใจว่าขั้นตอนที่ 1 และ 2 ของส่วนย่อยการบูตเครือข่ายจะทําให้บรรลุเป้าหมายใด การคลิกและไปยังลิงก์ต่างๆ ต้องใช้เวลาคิดมากเกินไป เราคิดว่าเราจะช่วยทำให้เรื่องนี้ชัดเจนขึ้นได้ โดยไม่ต้องไปยุ่งกับวัชพืชมากเกินไป
อย่างน้อยผมก็คงอธิบายภาพรวมระดับสูงของคอนเทนเนอร์หลักในขั้นตอนที่ 5 (ซึ่งคิดว่าจริงๆ แล้วเป็นขั้นตอนที่ 4) เพื่อให้ผู้อ่านเข้าใจเกี่ยวกับสิ่งที่จะทำโดยไม่ต้องคลิกลิงก์
สำหรับขั้นตอนที่ 3 และ 5 (จริงๆ คือ 4) เราจะอธิบายตัวอย่างโค้ดที่ยาวขึ้น
ขั้นตอนสุดท้ายคือลิงก์ไปยังปลั๊กอินและไฟล์ที่ติดตั้งเพื่อให้ผู้อ่านใช้งานได้ง่ายขึ้น
สุดท้าย เราจะแก้ไขเพื่อให้แน่ใจว่าแต่ละย่อหน้ามีแนวคิดไม่เกิน 1 แนวคิด (เพื่อให้อ่านแบบผ่านๆ ได้ง่ายๆ) ฉันจะทำให้น้ำเสียงสนุกสนาน / เป็นมิตรมากขึ้น และเพิ่มอีโมจิสัก 2 อัน
วิธีตรวจสอบบล็อกเชน
เราขอแนะนำให้เรียบเรียงย่อหน้าแรกให้เข้าใจง่ายขึ้น ฉันจะอธิบายว่าปลั๊กอินคืออะไร ผู้รับมอบสิทธิ์ทําหน้าที่อะไร (หรืออย่างน้อยก็ลิงก์ไปยังคําอธิบายหลักการพื้นฐาน) การปลอมบล็อกหมายความว่าอย่างไร และยกตัวอย่างเหตุการณ์เครือข่าย
กําหนดปัญหา: ฉันจะอธิบายให้ผู้อ่านทราบถึงความหมายของโหนดแบบเต็ม ลิงก์ไปยังคําอธิบายโดยละเอียดมากขึ้น และอธิบายข้อดีข้อเสียระหว่างโหนดแบบเต็มกับแอปพลิเคชันภายนอกได้ดียิ่งขึ้น สุดท้ายเราจะใส่ลิงก์ไปยังหน้าเริ่มต้นใช้งานก่อนหน้า ซึ่งก็คือวิธีตั้งค่าการทดสอบเน็ตและสภาพแวดล้อมในการพัฒนาซอฟต์แวร์ที่ใช้งานได้ ในตอนท้ายของส่วนย่อยนี้ (ในกรณีที่ผู้อ่านบังเอิญเข้ามาพบหน้านี้ก่อน)
Events API: จากรายการเหตุการณ์ที่ใช้ได้ เราไม่แน่ใจว่าควรใช้ "block.applied" เพื่อรับสิ่งที่ต้องการหรือไม่ แม้ว่าเคล็ดลับด้านล่างจะอธิบายให้เข้าใจได้ง่ายขึ้น แต่เราขออธิบายเรื่องนี้ก่อน
เราไม่แน่ใจว่า "block.applied" แสดงผลอะไร ฉันคิดว่าการทำให้วิญญาณนี้ชัดเจนคือสิ่งสำคัญ
ในตัวอย่างโค้ดท้ายๆ เราคิดว่าควรอธิบายให้ชัดเจนว่า "block.generatorPublicKey" แทนที่ "block.forger" (ในตัวอย่างซอร์สโค้ดจำลองก่อนหน้านี้) และ "delegateKey" แทนที่ "delegateWeAreMonitoring" สุดท้ายนี้ เราขอสลับ "delegateKey" กับ "generatorKey" ในคำสั่ง if เพื่อให้ตัวอย่างโค้ดและซอร์สโค้ดจำลองสอดคล้องกัน
การสร้างปลั๊กอิน ฉันจะอธิบายความหมายของ "เฟรมเวิร์ก" ในบริบทนี้ อย่างเช่น: เช่นเดียวกับการนั่งร้านจริงในสถานที่ก่อสร้าง เมื่อเราพูดถึงนั่งร้านในบริบทนี้ เราหมายถึงโครงสร้างง่ายๆ ที่สร้างไว้ล่วงหน้าสำหรับปลั๊กอินของคุณ ซึ่งยิ่งไปกว่านั้นคุณสามารถสร้างนั่งร้านจริงได้ด้วย
ฉันจะเพิ่มตัวอย่างโค้ดเพื่อเปลี่ยนชื่อไดเรกทอรีและปลั๊กอิน แสดงตัวอย่าง package.json และอธิบายความหมายของ "การเพิ่มการกําหนดค่าที่จําเป็น" ลงใน plugin.js
สรุปข้อมูลทั้งหมด: เราจะอธิบายการเปลี่ยนแปลงให้ชัดเจนยิ่งขึ้น ปิดท้ายด้วยการแสดงความยินดีและเน้นอีโมจิอื่นๆ ด้วย :)
วิธีส่งธุรกรรมแรกโดยใช้ ARK SDK
การเริ่มต้นใช้งาน: ฉันจะเพิ่มตัวอย่างโค้ดเพื่อให้ผู้ใช้สร้างไดเรกทอรีใหม่ด้วยการคัดลอกและวาง
เชื่อมต่อกับ Testnet: ฉันจะอธิบายว่า REST API คืออะไร ในกรณีที่ผู้อ่านไม่คุ้นเคย (หรืออย่างน้อยก็ใส่ลิงก์ไปยังคำอธิบาย) เราจะให้ลิงก์ไปยังตัวอย่างโปรแกรมดู JSON ฉันจะเลือกใช้ถ้อยคำที่เป็นมิตรมากขึ้นในเคล็ดลับที่ 2 (เพราะเราขอให้ผู้อ่านช่วยแนะนำ)
การเปลี่ยนเครื่องมือจัดการการกําหนดค่า: ฉันจะพูดถึงตัวอย่างข้อบกพร่องที่พบบ่อยซึ่งเกี่ยวข้องกับเครือข่าย และพิจารณาลิงก์ไปยังส่วนการแก้ปัญหา
ตั้งค่าบัญชีที่ส่งและรับ: ฉันจะเพิ่มตัวอย่างโค้ดเพื่อให้ผู้อ่านเปลี่ยนเป็นไดเรกทอรีการกําหนดค่าด้วยการคัดลอกวาง เพิ่มตัวอย่างโค้ดที่แสดงเนื้อหาของ delegates.json
วิธีส่งธุรกรรมโดยใช้ CLI ของ ARK Core Tester
ข้อกําหนดเบื้องต้น: เราจะเพิ่มตัวอย่างโค้ดที่แสดงวิธีรับสําเนาที่ใช้งานได้ของที่เก็บ GitHub ของ ARK Core และอีกตัวอย่างหนึ่งที่ย้ายโปรแกรมอ่านไปยังไดเรกทอรีที่ถูกต้อง
พื้นฐาน: ฉันจะทําให้ย่อหน้าแรกชัดเจนขึ้นสําหรับผู้ที่ไม่คุ้นเคยกับตัวแปรสภาพแวดล้อมของเส้นทาง
บทสรุป
โดยสรุปแล้ว นี่เป็นเพียงบันทึกสั้นๆ บางส่วนที่ฉันจดไว้ขณะอ่านเอกสารประกอบ เมื่อเราเริ่มทำโปรเจ็กต์ด้วยกัน ฉันต้องการทำตามกระบวนการด้วยตนเองเพื่อดูว่ามีปัญหาตรงไหน และใช้ความรู้นั้นเพื่อลดความซับซ้อนของเอกสารต่อไป
สุดท้ายนี้ แม้ว่าเราจะได้ตรวจสอบโปรเจ็กต์เพียงโปรเจ็กต์เดียว แต่เราคาดว่าการดำเนินการนี้จะใช้เวลาไม่เกิน 2-3 สัปดาห์ ตามที่ได้พูดคุยกันทางอีเมล เราคิดว่าเราสามารถทำงานร่วมกันในหลายโปรเจ็กต์ได้