تحتوي هذه الصفحة على تفاصيل مشروع كتابة فني مقبول في موسم Google من المستندات.
ملخّص المشروع
- مؤسسة مفتوحة المصدر:
- منظومة ARK المتكاملة
- الكاتب الفني:
- yslcrypto
- اسم المشروع:
- المشروع 1: بدء استخدام دليل تطوير تقنية سلسلة الكتل الأساسية
- طول المشروع:
- مدة زمنية عادية (3 أشهر)
وصف المشروع
إليك بعض الأفكار بعد القراءة من خلال قسم "البدء":
كيفية إعداد بيئة التطوير
التثبيت: سأشرح بالتفصيل كيفية تثبيت أدوات التطوير هنا. سأقدم عينات من التعليمات البرمجية، إلى جانب الأخطاء الشائعة وكيفية إصلاحها (يمكننا وضع رابط إلى صفحة استكشاف الأخطاء وإصلاحها هنا).
إدارة الاختبار الأول: الانطباع الأول: إنه أمر مربك جدًا الآن لشخص يتصفح سريعًا ويريد الإعداد بسرعة. في ما يلي بعض التغييرات التي أودّ إجراؤها:
ننصحك بتعريف المفاهيم الأساسية، مثل شبكة الاختبار.
سأقدّم المزيد من نماذج الرموز البرمجية الأقصر: mkdir وcd وما إلى ذلك. وسأجمّعها أيضًا حتى يتمكّن القرّاء من نسخها ولصقها بسهولة أكبر. لا شيء بسيط جدًا، ويحب الجميع النسخ واللصق.
عند القراءة للمرة الأولى، لم يتضح لي ما تحقّقه الخطوتان 1 و2 من القسم الفرعي "بدء التشغيل من الشبكة". إنّ النقر على الروابط والانتقال إليها يتطلّب الكثير من التفكير. أعتقد أنّه يمكننا توضيح ذلك أكثر بدون الخوض في التفاصيل.
سأقدّم على الأقل نظرة عامة على مستوى عالٍ على "الحاويات الأساسية" في الخطوة 5 (أعتقد أنّها الخطوة 4؟) حتى يحصل القارئ على بعض الأفكار حول ما يفعله بدون اتّباع رابط.
بالنسبة إلى الخطوتَين 3 و5 (4 في الواقع)، سأشرح عيّنات الرموز البرمجية الأطول.
في الخطوة الأخيرة، سأضيف رابطًا يؤدي إلى المكوّن الإضافي والملف المثبَّتَين لتسهيل الأمر على القارئ.
أخيرًا، سأعدّل بطريقة تضمن عدم وجود أكثر من فكرة واحدة لكل فقرة (يسمح بالتمرير بسهولة). أريد أيضًا أن أجعل الأسلوب أكثر مرحًا أو وديًا مع إضافة بعض الرموز التعبيرية.
كيفية مراقبة سلسلة الكتل
سأبسّط الفقرة الأولى. سأشرح ما هو المكوّن الإضافي وما يفعله المفوّض (أو على الأقل سأقدّم رابطًا لشرح المبادئ الأساسية)، وما يعنيه تزوير كتلة، وسأقدّم مثالاً على حدث شبكة.
تحديد المشكلة: سأعطي القارئ فكرة عن ماهية العقدة الكاملة، ورابطًا لشرح أكثر تفصيلاً، وأشرح بشكل أفضل المفاضلات بين عقدة كاملة وتطبيق خارجي. أخيرًا، سأضيف رابطًا في نهاية هذا القسم الفرعي يؤدي إلى صفحة البدء السابقة التي تشرح كيفية إعداد شبكة اختبار وبيئة تطوير صالحة (في حال عثر القارئ على هذه الصفحة أولاً).
Events API: من قائمة الأحداث المتاحة، ليس من الواضح أنّنا يجب استخدام block.applied للحصول على ما نريد. بالرغم من أنّ النصيحة أدناه أوضح، فقد أوضحتها من قبل.
لا يتضح لي ما يعرضه العمود block.applied. أعتقد أنه من المهم أن نوضح ذلك تمامًا.
في مثال الرمز البرمجي في النهاية، أعتقد أنّه من المفيد توضيح أنّ "block.generatorPublicKey" يحلّ محل "block.forger" (في مثال الرمز البرمجي السابق)، وأنّ "delegateKey" يحلّ محل "delegateWeAreMonitoring". أخيرًا، لضمان اتساق نماذج الرموز البرمجية والرموز البرمجية الوصفية، يمكن أيضًا تبديل "delegateKey" و"generatorKey" في عبارة if.
إنشاء المكوّن الإضافي: سأشرح معنى "الهيكل العظمي" في هذا السياق. على سبيل المثال: تمامًا مثل السقالات الحقيقية في موقع البناء، عندما نتحدث عن السقالات في هذا السياق، نقصد بنية بسيطة مُنشأة مسبقًا للمكوّن الإضافي يمكنك بناء البنية الحقيقية فوقها.
سأضيف عيّنات من الرموز البرمجية لإعادة تسمية الدليل والمكوّن الإضافي، وسأعرض مثالاً على package.json، وسأوضّح ما نقصده بـ "إضافة الإعدادات اللازمة" إلى plugin.js.
ربط ذلك معًا: أود أن أوضح ما هي التغييرات. يمكنك إنهاء الرسالة بعبارة تهاني وبعض رموز الإيموجي الإضافية :)
كيفية إرسال أول معاملة باستخدام ARK SDK
بدء الاستخدام: أريد إضافة نموذج رمز للسماح للمستخدم بإنشاء دليل جديد من خلال النسخ واللصق.
الاتصال بـ Testnet: سأشرح ما هي واجهة برمجة تطبيقات REST، في حال كان القارئ غير مألوف (أو على الأقل رابط لتفسير). أريد تضمين مثال لعارض JSON وإدراج رابط إليه. سأستخدم أسلوبًا أكثر ودية في النصيحة الثانية (لأنّنا نطلب من القارئ تقديم خدمة).
تغيير "مدير الإعدادات": أودّ ذكر أمثلة شائعة على الأخطاء المتعلّقة بالشبكة، والتفكير في ربط قسم تحديد المشاكل وحلّها.
إعداد حسابات الإرسال والاستقبال: أريد إضافة نموذج رمز للسماح للقارئ بالانتقال إلى دليل الإعدادات من خلال النسخ واللصق. سأضيف نموذج رمز برمجي يعرض محتويات delegates.json.
كيفية إرسال المعاملات باستخدام واجهة سطر الأوامر لدى مختبري ARK الأساسي
المتطلبات الأساسية: أريد إضافة نموذج رمز يوضّح كيفية الحصول على نسخة صالحة من مستودع GitHub الخاص بـ ARK Core، ونموذج آخر ينقل القارئ إلى الدليل الصحيح.
الأساسيات: أريد أن أجعل الفقرة الأولى أكثر وضوحًا لأولئك الذين ليسوا على دراية بمتغيّرات بيئة المسار.
الخاتمة
في الختام، إليك بعض الملاحظات الموجزة التي دوّنتها أثناء قراءة المستندات. عندما نبدأ في المشروع معًا، أود أن أتابع العملية بنفسي لأرى إلى أين أذهب. ويمكنك استخدام هذه المعرفة لتبسيط المستندات بشكل أكبر.
أخيرًا، على الرغم من أنّني راجعتُ مشروعًا واحدًا فقط هنا، لا أعتقد أنّ هذا الإجراء سيستغرق أكثر من أسبوعَين. وفقًا لما ناقشناه في مراسلاتنا عبر البريد الإلكتروني، أعتقد أنّه من الممكن العمل على عدة مشاريع خلال فترة عملنا معًا.