โครงการ National Resource for Network Biology (NRNB)

หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs

สรุปโปรเจ็กต์

องค์กรโอเพนซอร์ส:
แหล่งข้อมูลแห่งชาติด้านชีววิทยาเครือข่าย (NRNB)
นักเขียนเชิงเทคนิค
ราฮูล อกราวัล
ชื่อโปรเจ็กต์:
การปรับปรุงเอกสารประกอบของ Cytoscape.Js
ระยะเวลาของโปรเจ็กต์
ระยะเวลามาตรฐาน (3 เดือน)

คำอธิบายโปรเจ็กต์

# การทำให้ผู้เริ่มต้นเข้าถึงเอกสาร Cytoscape.js ได้มากขึ้น

ตามข้อมูลจำเพาะที่ได้จากพี่เลี้ยง เราได้แบ่งโปรเจ็กต์ออกเป็น 2 หมวดหมู่และต้องการนําฟีเจอร์เหล่านี้ไปใช้กับโปรเจ็กต์นี้ ฉันได้จัดเรียงลำดับความสำคัญโดยลดความสำคัญลง

  • ฟีเจอร์หลัก (ก่อนหน้าอันดับแรก)

    - ระยะที่ 1

  • การย้ายข้อมูลข้อกำหนด JSON ที่มีอยู่ซึ่งมีการอ้างอิงไฟล์ Markdown ไปยังความคิดเห็น JSDoc

  • ปรับแต่งและปรับปรุงเอกสารประกอบที่มีอยู่ เช่น เขียนคำอธิบายให้ดีขึ้นหรือเพิ่มตัวอย่างโค้ด

    - ระยะที่ 2

  • เขียนบทแนะนำใหม่และสร้างวิดีโอเพื่อครอบคลุมหัวข้อใหม่ๆ หรือเพื่อครอบคลุมหัวข้อพื้นฐานด้วยวิธีที่น่าสนใจยิ่งขึ้น

    - ระยะที่ 3

  • เขียนเดโมใหม่และสร้างวิดีโอเพื่อให้เห็นภาพว่าเว็บแอป Cytoscape ที่สมบูรณ์แบบเป็นอย่างไร

  • **เป้าหมาย-ยืด **

  • การปรับปรุงเอกสารโดยทั่วไป