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