หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- ภาษา Julia
- นักเขียนเชิงเทคนิค
- Shuo Liu
- ชื่อโปรเจ็กต์:
- LightGraphs Docs 2.0 และบทแนะนำ JuliaGraphs ที่ใช้งานง่าย
- ระยะเวลาของโปรเจ็กต์
- ใช้งานนาน (5 เดือน)
คำอธิบายโปรเจ็กต์
ในโครงการที่ดำเนินมาอย่างยาวนานนี้ ฉันจะปรับปรุงเว็บไซต์และเอกสารโมดูลต่างๆ ใน JuliaGraphs ให้ดีขึ้น โดยเฉพาะอย่างยิ่ง งานของฉันจะรวมถึงแต่ไม่จำกัดเพียงเนื้อหาต่อไปนี้
LightGraphs Docs 2.0 - 10 สัปดาห์
- ภาพรวม: LightGraphs.jl คือแพ็กเกจกราฟน้ำหนักเบาที่ได้รับการเพิ่มประสิทธิภาพสำหรับ Julia ซึ่งทำหน้าที่เป็นแกนหลักของระบบนิเวศ JuliaGraphs LightGraphs เวอร์ชัน 2.0 ที่กำลังจะเปิดตัวเป็นการเปลี่ยนแปลงพื้นฐานใน LightGraphs API เราจะตรวจสอบว่าเอกสารประกอบแสดงถึงฟีเจอร์ล่าสุดและดีที่สุดของ LightGraphs
- สิ่งที่ส่งมอบ: ฉันจะตรวจสอบเอกสาร API ที่มีอยู่เพื่อดูว่าเอกสารใดจะยังเหมือนเดิม และวิเคราะห์การเปลี่ยนแปลงที่ทำในเวอร์ชัน 2.0 เพื่อให้แน่ใจว่ามีการจัดทำเอกสารพร้อมตัวอย่างอย่างถูกต้อง ในระหว่างนี้ เราจะเขียนโพสต์ที่ไฮไลต์การเปลี่ยนแปลงที่สำคัญในรุ่น 2.0 เราจะสร้างคู่มือสำหรับผู้เริ่มต้นสำหรับผู้ที่เริ่มต้นใช้งานกราฟใน Julia เพื่อช่วยให้ผู้ใช้ใหม่เข้าใจ LightGraphs ได้ดียิ่งขึ้น
- หมายเหตุ: ในโปรเจ็กต์นี้ จะใช้ Documenter.jl เป็นเครื่องมือสร้างเอกสารเพื่อสร้างเอกสาร LightGraphs นอกจากข้อมูลอ้างอิง API สำหรับโมดูลอย่าง Coloring.jl แล้ว เรายังต้องการข้อมูลอ้างอิงสำหรับโมดูลย่อยอย่าง greedy_color.jl ด้วย เราจะหาวิธีเพิ่มข้อมูลอ้างอิงดังกล่าวเพื่อปรับปรุงเอกสารประกอบของ LightGraphs ยิ่งไปกว่านั้น ทฤษฎีกราฟยังเป็นสาขาทางเทคนิคที่ค่อนข้างซับซ้อนในด้านคณิตศาสตร์และยังคลุมเครือสำหรับผู้ที่ไม่มีพื้นฐานด้านคณิตศาสตร์ ฉันมีส่วนร่วมในการวิจัยทางวิชาการมาประมาณ 2 ปีและเขียนบล็อกโพสต์มากมายในเว็บไซต์ส่วนตัว จึงมั่นใจที่จะอธิบายสาระสำคัญของอัลกอริทึมต่างๆ และบอกเคล็ดลับว่าควรใช้อัลกอริทึมใดในสถานการณ์ต่างๆ เมื่อสร้างคู่มือสําหรับผู้เริ่มต้น
บทแนะนำ JuliaGraphs - 10 สัปดาห์
- ภาพรวม: เอกสารประกอบของแพ็กเกจ JuliaGraphs ส่วนใหญ่มีไว้สำหรับนักพัฒนาซอฟต์แวร์ เราจะเพิ่มตัวอย่างง่ายๆ และแสดงการใช้งานของแต่ละฟีเจอร์เพื่อให้ผู้ใช้เข้าถึงได้ง่ายขึ้น
- สิ่งที่ส่งมอบ: เราจะตรวจสอบบทแนะนำ LightGraphs ที่มีอยู่เพื่อดูว่าต้องเพิ่มเนื้อหาใดบ้าง และสาธิตการใช้งานและแรงจูงใจของฟีเจอร์แต่ละรายการ จากนั้นเราจะทำตามรูปแบบของ JuliaGraphsTutorials เพื่อขยายบทแนะนำ JuliaGraphs รวมถึงคู่มือสำหรับผู้เริ่มต้นในระบบนิเวศ LightGraphs
- หมายเหตุ: เนื้อหาของ JuliaGraphsTutorials ยังไม่ละเอียดพอในขณะนี้ ชิ้นงานที่ระบุไว้ข้างต้นส่วนใหญ่มีไว้สำหรับแพ็กเกจ LightGraphs หากมีเวลา เราจะเพิ่มบทแนะนำสำหรับโมดูลอื่นๆ ใน JuliaGraphs ด้วย เช่น GraphPlot.jl, MetaGraphs.jl และ SimpleWeightedGraphs.jl
เว็บไซต์ JuliaGraphs Central - 4 สัปดาห์
- ภาพรวม: เว็บไซต์หลักของ JuliaGraphs มีภาพรวมของแพ็กเกจของระบบนิเวศ อย่างไรก็ตาม เนื้อหาส่วนใหญ่ยังคงเป็นคำอธิบายและสามารถปรับปรุงให้ดียิ่งขึ้นเพื่อใช้เป็นทรัพยากรแรกสำหรับผู้เริ่มต้นใช้งานกราฟใน Julia ผมจะหาวิธีง่ายๆ ในการแสดงภาพเพื่อไฮไลต์ฟีเจอร์ของแพ็กเกจ JuliaGraphs แบบต่างๆ
- สิ่งที่ส่งมอบ: ฉันจะเสนอกรณีการใช้งานและตัวอย่างเพื่อไฮไลต์ฟังก์ชันการทำงานของแพ็กเกจ JuliaGraphs และทำการตรวจสอบเพื่อให้มั่นใจว่าแพ็กเกจยังคงมีความเกี่ยวข้องและได้รับการสนับสนุน เราจะสร้างส่วนซึ่งไฮไลต์การใช้งานที่แตกต่างกันของแพ็กเกจต่างๆ ในโดเมนต่างๆ (การดูแลสุขภาพ การศึกษา ฯลฯ) หากมีเวลา เราจะหาคำอธิบายภาพเกี่ยวกับอัลกอริทึมที่ใช้ในกราฟ
- หมายเหตุ: แพ็กเกจ JuliaGraphs หลายรายการมีการใช้งานกันอย่างแพร่หลายในโดเมนต่างๆ นอกจากการพล็อตส่วนขยาย เช่น DiGraph for NetworkViz แอปพลิเคชันอื่นๆ บางวิชาที่จะใส่เพิ่ม เช่น MetaGraph for BioStructures in Biology, DijkstraState for TrafficAssighnment in Urban Planning, DiGraph for TreeView in Education ฯลฯ