หน้านี้มีรายละเอียดของโครงการเขียนเชิงเทคนิคที่ยอมรับใน Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- แหล่งข้อมูลชีววิทยาเครือข่ายแห่งชาติ (NRNB)
- ผู้เขียนด้านเทคนิค:
- Rahul Agrawal
- ชื่อโปรเจ็กต์:
- การปรับปรุงเอกสารประกอบของ Cytoscape.Js
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
# การทำให้เอกสาร Cytoscape.js เข้าถึงได้ง่ายขึ้นสำหรับมือใหม่
ตามข้อกำหนดที่ได้รับจากที่ปรึกษา ฉันได้แบ่งโครงการออกเป็น 2 หมวดหมู่ และฉันต้องการนำฟีเจอร์เหล่านี้ไปใช้กับโครงการนี้ ฉันได้จัดเรียงลำดับความสำคัญที่ลดลงไว้
ฟีเจอร์หลัก (ก่อนหน้าลำดับต้นๆ)
- ระยะที่ 1
การย้ายข้อมูลข้อกำหนด JSON ที่มีอยู่ด้วยการอ้างอิงถึงไฟล์มาร์กดาวน์ไปยังความคิดเห็น JSDoc
ปรับแต่งและปรับปรุงเอกสารประกอบที่มีอยู่ เช่น การเขียนคำอธิบายให้ดีขึ้นหรือเพิ่มข้อมูลโค้ดตัวอย่าง
- ระยะที่ 2
เขียนบทแนะนำใหม่และสร้างวิดีโอเพื่อพูดถึงหัวข้อใหม่ๆ หรือพูดถึงหัวข้อพื้นฐานด้วยวิธีที่น่าสนใจมากขึ้น
- ระยะที่ 3
เขียนเดโมใหม่และสร้างวิดีโอเพื่อให้เห็นภาพว่าเว็บแอปของ Cytoscape ที่สมบูรณ์เป็นอย่างไร
**เป้าหมายยืด **
การปรับปรุงทั่วไปบางอย่างในเอกสารประกอบ