โปรเจ็กต์ Matplotlib

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

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

องค์กรโอเพนซอร์ส

Matplotlib

นักเขียนเชิงเทคนิค

jeromev

ชื่อโปรเจ็กต์:

การพัฒนาเส้นทางรายการ Matplotlib

ระยะเวลาของโปรเจ็กต์

ระยะเวลามาตรฐาน (3 เดือน)

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

บทนำ

คำแนะนำโปรเจ็กต์ของ Matplotlib สำหรับ Google Season of Docs ในปีนี้เกี่ยวข้องกับการสร้างเนื้อหาที่ช่วยแนะนำ Matplotlib ให้แก่ผู้ใช้ใหม่ สำหรับการพัฒนาเส้นทางรายการ Matplotlib เราขอเสนอแนวทางอื่นที่แตกต่างจากเอกสารประกอบปัจจุบัน ฉันเป็นนักเขียนใหม่ด้านเทคนิคในอุตสาหกรรม แต่ภูมิหลังของฉันอยู่ในสาขาการศึกษาและสาขาที่เกี่ยวข้องกับการศึกษา บทความเชิงเทคนิคและการศึกษามีความคล้ายคลึงกันมาก โดยมุ่งเน้นที่การสร้างเนื้อหาที่เข้าใจและช่วยให้ผู้ใช้ทำงานให้เสร็จได้ด้วยแหล่งข้อมูลที่ให้ไว้

ในบริบทนี้ เอกสารประกอบของ Matplotlib จะได้ประโยชน์จากการปรับปรุงเพื่อเห็นอกเห็นใจผู้ใช้ใหม่ เนื้อหาส่วนใหญ่ในตอนนี้ประกอบด้วยข้อมูลที่สุ่มและภาพที่ไม่มีป้ายกำกับ ซึ่งเหมาะสำหรับการแสดงภาพและฟีเจอร์ของ Matplotlib อย่างรวดเร็ว อย่างไรก็ตาม สำหรับกรณีการใช้งานของผู้ใช้ใหม่กับ Matplotlib การข้ามผ่านการแปลงข้อมูลเป็นภาพนั้นเป็นเรื่องยาก

บริบทในแนวทางอธิบายเป็นวิธีแก้ปัญหานี้ การเขียนกระบวนการผ่านตัวอย่างในโลกแห่งความเป็นจริงแสดงให้เห็นว่าเรากําลังแสดงถึงความเข้าใจสภาพแวดล้อมที่ผู้ใช้ทํางาน วิธีนี้ช่วยปรับปรุงความสัมพันธ์ระหว่างเอกสารประกอบกับผู้ใช้ในแง่ของการบรรลุเป้าหมายหรือความคาดหวังในการทํางานให้เสร็จสมบูรณ์

ผู้ใช้มีวัตถุประสงค์ที่ได้จากแหล่งที่มาที่สอดคล้องกัน เช่น นักวิทยาศาสตร์ข้อมูลของบริษัทรองเท้าต้องนำเสนอข้อมูลลูกค้าต่อทีมเพื่อแสดงแนวโน้มการช็อปปิ้งเมื่อเวลาผ่านไป ในกรณีนี้ ผู้ใช้ต้องเรียนรู้วิธีไปยังส่วนต่างๆ ของ Matplotlib และใช้เครื่องมือภายในไลบรารีเพื่อทำงานให้เสร็จ

เมื่อมีบริบทเพิ่มเติมเพื่อสนับสนุนเอกสารประกอบ ผู้ใช้ใหม่อาจระบุหัวข้อได้ดีขึ้น วัตถุประสงค์ที่ได้จากผู้ใช้จะสอดคล้องกับเอกสารประกอบ เราหวังว่าจะบรรลุวิสัยทัศน์ที่ Tom Caswell นักพัฒนาซอฟต์แวร์ระดับอาวุโสได้พูดถึงในการสัมภาษณ์เมื่อปี 2017 ว่า "การได้คนที่เขียนหนังสือได้จริงและเข้าใจผู้ใช้ ที่จะเขียนหนังสือ "ข้อมูลเบื้องต้นเกี่ยวกับ Matplotlib" หนา 200 หน้า และทำให้หนังสือเล่มนี้เป็นหน้าแรกในเอกสาร"

แนวทางทางเลือกสำหรับการเขียนเชิงซ้อน

เอกสารประกอบปัจจุบันแสดงฟีเจอร์ของ Matplotlib ซึ่งก็คือสิ่งที่ผู้ใช้ทำกับคลังได้ เช่น บทแนะนำมักเป็นไปตามรูปแบบที่ไม่ได้อธิบายถึงวิธีการพื้นฐาน

{what the method does} -> {parameters} -> {returns} -> {related links} -> {examples}

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

การให้แผนภาพ รูปภาพ หรือภาพอื่นๆ เพิ่มเติมจะช่วยสร้างโอกาสการเรียนรู้ใหม่ๆ โครงสร้างด้านล่างนี้ยังใช้เป็นเทมเพลตสำหรับเนื้อหาใหม่ได้ด้วย นอกจากนี้ การเพิ่มรูปภาพหรือกราฟิกที่ไม่มีข้อความยังอาจได้รับประโยชน์จากฟีเจอร์ต่างๆ เช่น ข้อความไฮไลต์และเครื่องหมายช่วยสอน บางครั้งการไปยังส่วนต่างๆ ของรูปภาพอาจทำได้ยากขึ้นหากไม่มีตัวบ่งชี้ว่าโค้ดเปลี่ยนรูปแบบเป็นเอาต์พุตที่ดำเนินการอย่างไรหรือที่ใด เราเชื่อว่าวิดีโอขาดองค์ประกอบภาพที่น่าสนใจซึ่งอาจช่วยส่งเสริมความเข้าใจในหัวข้อได้ดียิ่งขึ้น

{method explanation} -> {expository use case/scenario} -> {sample code} -> {parameters} -> {returns} -> {additional examples} -> {informational topic/subject affinity links}

แนวทางการใช้การเขียนอธิบายเพื่อเขียนเอกสารนี้มีศักยภาพอย่างมาก การที่ผู้ใช้มองเห็นแนวคิดที่หลากหลายในการเปลี่ยนรูปแบบ พวกเขาจะสามารถระบุกลยุทธ์ที่อยู่เบื้องหลังการพัฒนาการแสดงข้อมูลเป็นภาพได้ดีขึ้น ความรู้นี้จะช่วยให้ผู้ใช้สร้างสรรค์สิ่งใหม่ๆ และใช้ประโยชน์จากฟีเจอร์ต่างๆ ตามที่แสดงโดยตัวอย่างตาม Use Case ในชีวิตจริง

เมื่อ Matplotlib ได้รับความนิยมมากขึ้น ความสม่ำเสมอในด้านความง่ายในการใช้งานและความเข้าถึงได้ก็เป็นเครื่องพิสูจน์ชื่อเสียงของไลบรารี ลักษณะเหล่านี้ช่วยให้สามารถแสดงรูปแบบและกลยุทธ์ทั่วไปที่ปรากฏได้ทั้งในโค้ดและเอกสารประกอบ หาก Matplotlib เป็นโปรแกรมที่เขียนได้ง่ายและเป็นมาตรฐานสำหรับผู้ใช้ ดังที่เห็นได้จากการใช้งานที่เพิ่มขึ้นและทรัพยากรที่ขยายตัว ก็อาจเหมาะกับเอกสารประกอบทางเทคนิคด้วย

เมื่อพบปัญหา ผู้ใช้มักจะใช้การค้นหาเพื่อแก้ปัญหา การให้ผู้ใช้สร้างหลักสูตรของตนเองในเอกสารประกอบจะมีประสิทธิภาพมากกว่าการพึ่งการค้นหาเป็นวิธีหลักในการไปยังส่วนต่างๆ ในความหมายนี้ ผู้ใช้จะค้นหาวิธีแก้ปัญหาของตนเอง จากนั้นเมื่อพบปัญหาอื่นหรือต้องการข้อมูลเพิ่มเติม ผู้ใช้จะใช้ลิงก์ที่ฝังไว้ซึ่งมีทั้งลิงก์ที่ละเอียดและครบถ้วน

ซึ่งเกี่ยวข้องกับสถาปัตยกรรมจากล่างขึ้นบนในระบบขององค์กร สําหรับทุกหัวข้อใน Matplotlib เครือข่ายลิงก์ที่หลากหลายซึ่งเชื่อมโยงกับหัวข้อที่เกี่ยวข้องและหัวข้อที่ให้ข้อมูลจะช่วยสร้างเครือข่ายที่มีประสิทธิภาพ ตลอดทั้งเครือข่ายนี้ ผู้ใช้มีแนวโน้มที่จะใช้เอกสารประกอบต่อไปเมื่อไปยังหัวข้อที่ต้องการและสำรวจข้อมูลเพิ่มเติมที่เกี่ยวข้องกับหัวข้อนั้น

สิ่งกีดขวาง

โปรเจ็กต์ที่ครอบคลุมและละเอียดขนาดนี้มักมีปัญหาอยู่เสมอ ในฐานะนักเขียนเนื้อหาทางเทคนิคหน้าใหม่ในอุตสาหกรรม ฉันมีประสบการณ์เพียงเล็กน้อยในการใช้ Sphinx และ ReST เพื่อเขียนเอกสารประกอบ ฉันยังไม่ค่อยได้ใช้ Matplotlib และ Git การใช้ระบบทั้ง 4 อย่างนี้และทำความคุ้นเคยกับการใช้ระบบเพื่อการทำงานร่วมกันและการค้นคว้าต้องใช้เวลา ฉันจะต้องจัดสรรเวลาในช่วงการสร้างความสัมพันธ์ของชุมชนและก่อนหน้านั้นเพื่อสร้างรากฐานที่จำเป็นสำหรับเส้นทางระดับเริ่มต้น ในระหว่างนี้ หากพบปัญหาเกี่ยวกับแนวคิดและพื้นฐาน เราต้องติดต่อชุมชนเพื่อขอรับการสนับสนุนเพิ่มเติม

การประสานงานในการทำงานร่วมกันระหว่างเขตเวลาและแพลตฟอร์มออนไลน์ก็จะต้องมีการปรับเปลี่ยนเช่นกัน ผู้คนในอุตสาหกรรมใช้ช่องทางการสื่อสารที่หลากหลาย ดังนั้นเราจึงต้องเข้าถึงได้ง่ายและเข้าถึงได้ในทุกสื่อ เราจะแสดงความโปร่งใสในการให้ความสำคัญกับความคาดหวังที่แตกต่างกันตลอดกระบวนการ แม้ว่าฉันเพิ่งเริ่มรับงานประเภทนี้ในอุตสาหกรรม แต่ฉันก็มุ่งมั่นที่จะรับผิดชอบต่อตนเองและพร้อมรับฟังความคิดเห็นและการวิจารณ์ เราคิดว่าคุณสมบัติเหล่านี้มีประโยชน์ไม่ว่าคุณจะทำงานในสาขาใดก็ตาม

นอกจากนี้ การทดสอบความสามารถในการใช้งานที่เพิ่มขึ้นคือส่วนหนึ่งของเอกสารประกอบที่เราเชื่อว่าจะเป็นประโยชน์ต่อเส้นทางการเข้าสู่ Matplotlib การทำแบบสำรวจเพื่อดูความสามารถในการใช้งานของเนื้อหามีจุดประสงค์เพื่อระบุโปรไฟล์ของผู้ใช้ เช่น ข้อมูลประชากร ข้อมูล เช่น ประสบการณ์ของผู้ใช้ อุตสาหกรรม และประวัติการแก้ปัญหามีค่า ข้อมูลเหล่านี้ช่วยสร้างภาษาของกระบวนการ เมื่อการเขียนพบกับผู้อ่านในระดับที่ตนเองถนัด เนื้อหาจะพัฒนาไปไกลกว่าการเป็นเพียงการสอนเพียงอย่างเดียว

ปัญหาครั้งใหญ่มักขึ้นอยู่กับการสร้างแนวทางทดสอบความสามารถในการใช้งานอย่างต่อเนื่อง เป็นเรื่องปกติมากที่จะมีการทดสอบเพียงครั้งเดียว (หากมี) ในระหว่างการพัฒนาเนื้อหา การทดสอบความสามารถในการใช้งานเป็นประจำจะช่วยขับเคลื่อนการเล่าเรื่องของเนื้อหา เราหวังว่าจะได้กำหนดเวลาหรือทำการทดสอบความสามารถในการใช้งานกับชุมชน Matplotlib เป็นประจำ

บทสรุป

ฉันมีประสบการณ์เล็กน้อยในการใช้ Python และ Matplotlib ในเวลาว่าง สิ่งที่ฉันได้เรียนรู้ด้วยตนเองในช่วง 2-3 เดือนที่ผ่านมานั้นได้รับความช่วยเหลือจากเอกสารประกอบปัจจุบันและความอยากรู้อยากเห็นของฉันเอง วิดีโอและก็มีที่ปรึกษาอยู่จำนวนหนึ่งที่ฉันก็มี ในช่วงเวลานั้นเช่นกัน ฉันยังต้องเรียนรู้อะไรอีกมากและยังมีจุดปรับปรุงได้อีกมากเมื่อสร้างหลักสูตรการเขียนโปรแกรมของตัวเองที่สนใจ

หลังจากได้เห็นแนวคิดที่ Matplotlib และชุมชนมีสำหรับ GSoD เรารู้สึกว่านี่จะเป็นประสบการณ์ที่ยอดเยี่ยมในการปรับปรุงทักษะในฐานะผู้เขียนเนื้อหาทางเทคนิคและได้รับโอกาสเรียนรู้เพิ่มเติมจากผู้คนเบื้องหลัง เรารู้สึกว่าโปรเจ็กต์ Matplotlib นี้มีทั้งความหมายและเป็นสิ่งที่เราหลงใหลในอุดมการณ์

เป้าหมายของเราในฐานะผู้เขียนเนื้อหาทางเทคนิคในการปรับปรุงคู่มือการใช้งานคือช่วยให้ผู้ใช้ทำงานที่ต้องการได้สำเร็จโดยไม่ต้องกังวลกับฟีเจอร์ที่มีให้ เราเชื่อว่าเอกสารประกอบที่ดีที่สุดจะต้องพัฒนาและปรับให้เข้ากับผู้ใช้อย่างต่อเนื่อง รวมถึงช่วยให้ผู้ใช้ทุกคนไปยังโซลูชันของตนเองได้