דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- המשאב הלאומי לביולוגיה של הרשת (NRNB)
- כתב טכני:
- ראוול אגרוואל
- שם הפרויקט:
- שיפור התיעוד של Cytoscape.Js
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
# הפיכת התיעוד של Cytoscape.js לנגיש יותר למתחילים.
בהתאם למפרט שנתן המנטור, חילקתי את הפרויקט לשתי קטגוריות ואני רוצה להטמיע את התכונות האלו בפרויקט הזה. סידרתי בסדר יורד של עדיפות.
תכונות מפתח (קודמות)
- שלב 1
העברת מפרט ה-JSON הקיים עם הפניות לקובצי Markdown אל התגובות ב-JSDoc
צמצום ושיפור של התיעוד הקיים, כמו כתיבת תיאור טוב יותר או הוספה של עוד קטעי קוד לדוגמה
- שלב 2
כתיבת מדריכים חדשים ויצירת סרטונים שעוסקים בנושאים חדשים או לסקירת נושאים בסיסיים בדרכים מעניינות יותר.
- שלב 3
כתיבת הדגמות חדשות ויצירת סרטונים שיספקו תחושה של אפליקציות אינטרנט מלאה בפורמט Cytoscape.
**יעדי המשך **
כמה שיפורים כלליים למסמכי התיעוד.