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