หน้านี้มีรายละเอียดโครงการงานเขียนเชิงเทคนิคที่ได้รับการยอมรับใน Google Season of เอกสาร
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- ภาษา Julia
- นักเขียนเชิงเทคนิค
- mkg33
- ชื่อโปรเจ็กต์:
- เอกสารประกอบแบบรวมของ Scientific Machine Learning
- ระยะเวลาของโปรเจ็กต์
- ดำเนินงานมาอย่างยาวนาน (5 เดือน)
คำอธิบายโปรเจ็กต์
ฉันต้องการทํางานเพื่อรวมองค์กร SciML เนื่องจากยังมีช่องว่างในการปรับปรุงอีกมากมายในเรื่องนี้ และแน่นอนว่าการทําโปรเจ็กต์นี้ให้เสร็จสมบูรณ์จะเป็นประโยชน์ต่อโปรแกรมเมอร์ Julia และผู้มีส่วนร่วม/ผู้ดูแล SciML ที่ใช้งานอยู่ แพ็กเกจที่กระจัดกระจายไปทั่ว SciML มีเครื่องมือที่มีประโยชน์มาก แต่ก็มีความเสี่ยงอยู่เสมอที่ผู้ใช้อาจไม่สังเกตเห็น (โดยเฉพาะผู้มาใหม่) เพียงเพราะผู้ใช้ไม่พบแพ็กเกจดังกล่าวและนำแพ็กเกจไปใช้แก้ปัญหาไม่ได้
ซึ่งค่อนข้างน่าหงุดหงิดเนื่องจากวัตถุประสงค์หลักของแพ็กเกจคือการเข้าถึงกลุ่มผู้ชมที่หลากหลายซึ่งเป็นโปรแกรมเมอร์ (ทั้งมือใหม่และผู้เชี่ยวชาญ) เพื่อเป็นการหลีกเลี่ยงสถานการณ์ที่อธิบายไว้ข้างต้น เราขอแนะนำให้แก้ไข "หน้าแรก" ของเอกสารประกอบ SciML อย่างละเอียดและสร้างฮับที่ผู้ใช้สามารถใช้เพื่อเรียกดูแพ็กเกจที่เกี่ยวข้องและสำรวจระบบนิเวศที่กำลังเติบโต นอกจากนี้ยังใช้เป็นข้อมูลอ้างอิงที่มีคุณค่าสําหรับผู้ใช้ที่มีประสบการณ์มากขึ้นและช่วยให้ทํางานได้อย่างมีประสิทธิภาพมากขึ้น
ก่อนอื่น จะต้องมีการแก้ไขเอกสารประกอบที่มีอยู่ของแพ็กเกจทั้งหมด โดยพิจารณาจากปัญหาด้านรูปแบบพื้นฐานที่สุด (เช่น การสะกดคำ เครื่องหมายวรรคตอน ไวยากรณ์ ฯลฯ) SciML ต้องมีคู่มือสไตล์ที่เป็นรูปธรรม (สิ่งที่ขาดไม่ได้สำหรับการเปลี่ยนแปลงข้อมูลเก่าและเพื่อใช้เป็นข้อมูลอ้างอิงในอนาคต) เพื่อให้สไตล์สอดคล้องกัน การเริ่มใหม่ตั้งแต่ต้นคงเป็นการเสียเวลา แต่ควรอิงตามรูปแบบ Julia ที่มีอยู่และใส่รายการใหม่สำหรับปัญหาเฉพาะของ SciML
เมื่อคู่มือสไตล์เสร็จสมบูรณ์แล้ว เราตั้งใจจะแก้ไขเอกสารประกอบปัจจุบันในระยะที่ 2 ของโปรเจ็กต์ ซึ่งจะทำให้เอกสารดูเป็นมืออาชีพและมีความเสถียรมากขึ้น เราได้สร้างคำขอดึงข้อมูลหลายรายการที่แสดงแนวทางในการดำเนินการนี้ ในขั้นตอนนี้ เราตั้งใจที่จะพัฒนา (และใช้งาน) ระบบการอ้างอิงที่มีประสิทธิภาพด้วย งานแรกสุดคือการอัปเดตหน้าการอ้างอิงที่ล้าสมัย
ระยะที่ 3 ซึ่งอาจกล่าวได้ว่าสำคัญที่สุด จะเกี่ยวข้องกับการออกแบบแผนพัฒนา SciML ซึ่งจะเน้นการโต้ตอบระหว่างแพ็กเกจต่างๆ ยิ่ง 2 แพ็กเกจมีความสอดคล้องกัน (ซึ่งเกี่ยวข้องกับปัญหาหรือตัวโค้ด) แพ็กเกจก็จะยิ่งปรากฏในรายการ "ดูเพิ่มเติม" มากขึ้น ฉันขอเสนอให้สร้างคีย์คำแนะนำ 2 คีย์ คีย์หนึ่งสำหรับความคล้ายคลึงกันของโค้ดและอีกคีย์หนึ่งสำหรับความคล้ายคลึงของปัญหา วิธีนี้จะช่วยให้ผู้ใช้ระบุแพ็กเกจอื่นๆ ที่อาจมีประโยชน์ได้เร็วกว่าการเรียกดูที่ยุ่งยากในรีโพซิทอรีและเอกสารประกอบที่เกี่ยวข้อง แทนที่จะแสดงรายการการเชื่อมโยงที่เป็นไปได้ทั้งหมดของแพ็กเกจ ฉันขอมุ่งเน้นที่การเชื่อมต่อที่มีขนาดใหญ่มากขึ้นและพยายามนำเสนอลิงก์ของลูกค้าด้วยแพ็กเกจขนาดเล็ก (วิธีนี้จะขยายไปสู่การอัปเดตบทแนะนำที่ควรระบุการเชื่อมต่อกับแพ็กเกจอื่นด้วย) วิธีนี้ช่วยให้มั่นใจได้ว่ารายการ "ดูเพิ่มเติม" จะให้ข้อมูลโดยไม่จำเป็นต้องแสดงรายการชุดค่าผสมของแพ็กเกจอย่างละเอียด