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