בדף הזה מופיעים הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Docs ל-Google Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- הסביבה העסקית של ARK
- כותבים טכניים:
- yslcrypto
- שם הפרויקט:
- פרויקט 1 – מדריך למתחילים לפיתוח בלוקצ'יין ליבה
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
הנה כמה רעיונות לאחר קריאת הקטע 'תחילת העבודה':
איך להגדיר את סביבת הפיתוח
התקנה: כאן אסביר בהרחבה איך להתקין את כלי הפיתוח. אשמח לספק דוגמאות קוד, יחד עם שגיאות נפוצות והדרכים לתקן אותן (אפשר לקשר כאן לדף לפתרון בעיות).
התחלת הבדיקה הראשונה: הרושם הראשון: זה די מבלבל כרגע מי שעושה רפרוף ורוצה לבצע את ההגדרה במהירות. הנה כמה דברים שאני הייתי משנה:
כדאי להגדיר גם מושגים בסיסיים כמו testnet.
הייתי נותן דוגמאות קוד קצרות יותר: mkdir, cd וכו'. בנוסף, הייתי רוצה לקבץ אותן כדי שהקוראים יוכלו להעתיק ולהדביק בקלות רבה יותר. אין דבר שהוא פשוט מדי, וכולם אוהבים להעתיק ולהדביק.
בקריאה הראשונה לא ברור לי מהם היעדים של שלבים 1 ו-2 בקטע 'הפעלה מרשת'. לחיצה על הקישורים וגלישה בהם דורשת מחשבה רבה מדי. לדעתי אפשר להסביר את זה בצורה ברורה יותר בלי להיכנס לפרטים קטנים מדי.
לפחות כדאי לתת סקירה כללית ברמה גבוהה על core-container בשלב 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: אשמח להסביר מהו API ל-REST, למקרה שהקוראים לא מכירים (או לכל הפחות מספקים קישור להסבר). אשמח להוסיף קישור לדוגמה של כלי להצגת קובצי JSON. הייתי משתמשת בנימה ידידותית יותר בטיפ השני (כי אנחנו מבקשים מהקורא טובה).
שינוי מנהל התצורה: אזכר דוגמאות נפוצות לבאגים שקשורים לרשת, וכדאי לקשר לקטע פתרון בעיות.
הגדרת חשבונות שליחה וקבלה: אוסיף דוגמת קוד כדי לאפשר לקורא לשנות לספריית ההגדרות באמצעות העתקה והדבקה. כדאי להוסיף דוגמה לקוד שמציגה את התוכן של delegates.json.
איך שולחים עסקאות באמצעות CLI של ARK CORE TESTER
תנאים מוקדמים: אשמח להוסיף דוגמה לקוד שמראה איך לקבל עותק פעיל של המאגר של ARK Core ב-GitHub, ודוגמה נוספת שמעבירה את הקורא לספרייה הנכונה.
יסודות: הפיסקה הראשונה צריכה להיות ברורה יותר למי שלא מכיר את משתני הסביבה של הנתיב.
סיכום
לסיום, אלה רק כמה הערות קצרות שכתבתי בזמן הקריאה במסמכים. כשנתחיל לעבוד על הפרויקט ביחד, אני רוצה לעבור את התהליך בעצמי כדי לראות איפה אני נתקע. ואז להשתמש בידע הזה כדי לפשט עוד יותר את המסמכים.
לסיום, למרות שעברתי כאן רק על פרויקט אחד, אני לא רואה את התהליך נמשך יותר מכמה שבועות. כפי שציינתי בהודעות האימייל שלנו, לדעתי נוכל לעבוד על כמה פרויקטים במהלך שיתוף הפעולה שלנו.