โปรเจ็กต์ NumPy

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

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

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

NumPy

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

cooperrc

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

เอกสารประกอบของ NumPy สำหรับการศึกษาของชุมชน

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

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

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

บทนำ

NumPy มอบการประมวลผลที่สะอาดและอิงตามอาร์เรย์ที่รวดเร็วในไลบรารีซอฟต์แวร์โอเพนซอร์สแบบไม่เสียค่าใช้จ่าย ซึ่งเป็นแพ็กเกจพื้นฐานในแพ็กเกจ SciPy สําหรับการประมวลผลที่เป็นระบบ [1] โปรเจ็กต์กว่า 370,000 รายการใช้สำหรับการประมวลผลอาร์เรย์ที่มีประสิทธิภาพ [2] ผู้ใช้ NumPy จะพบกับเว็บไซต์ใหม่ที่มีแอปพลิเคชันและกรณีศึกษา [1] เมื่อพบหน้าเอกสารประกอบ ผู้ใช้ใหม่จะพบลิงก์ "เริ่มที่นี่" หลายลิงก์และบทแนะนำแนะนำที่อาจสร้างความยุ่งยากสำหรับผู้เริ่มต้น เช่น NumPy Basics/การสลับไบต์ ฉันเริ่มใช้ NumPy เมื่อ 10 ปีก่อนตอนเรียนระดับบัณฑิตศึกษา ฉันพบว่าตัวเองกำลังปะติดปะต่อบล็อกโพสต์ เนื้อหาบรรยาย และคำตอบใน StackExchange เพื่อหลีกเลี่ยงการอ่านเอกสารประกอบของ NumPy ปัจจุบันมีการสนทนาใน StackExchange ที่ทำงานกับ NumPy มากกว่า 3.6 แสนรายการ เราคิดว่าผู้ใช้รายอื่นๆ คงประสบความสําเร็จใน NumPy ด้วยวิธีคล้ายๆ กัน องค์ประกอบสำคัญของเครื่องมือทางการศึกษาคือการสื่อสารและชุมชน [4] เอกสารประกอบต้องสร้างชุมชนที่สะท้อนถึงเป้าหมายที่ต้องการของโปรเจ็กต์ เอกสารประกอบควรเป็นคู่มือที่ชัดเจนสอดคล้องกันสำหรับผู้ใช้ใหม่ บทแนะนำควรมีขั้นตอนที่ผู้ใช้ใหม่ทำตามได้ง่ายและช่วยให้ผู้ใช้คุ้นเคยกับคลัง [3] เอกสารประกอบควรต้อนรับผู้ใช้ใหม่สู่ชุมชน NumPy ทั้งโครงสร้าง ความรวดเร็ว และผู้เขียนเอกสารต่างก็ต้องสร้างพื้นที่ที่เปิดรับการสำรวจและการสื่อสาร ข้อเสนอนี้จะจัดระเบียบและเติมเต็มช่องว่างในเอกสารประกอบ NumPy ปัจจุบันเพื่อให้ผู้ใช้ใหม่ได้รับความรู้และต้อนรับเข้าสู่ชุมชน

ความรู้ที่ผู้ใช้สื่อสารได้มาจากการตรวจสอบและการทดสอบ [4,5] ความรู้ขึ้นอยู่กับวิธีการทดสอบและประเมิน เนื้อหาที่มีเป้าหมายและการประยุกต์ใช้อย่างชัดเจนช่วยให้ผู้ใช้ทดสอบและประเมินแนวคิดและวิธีการใหม่ๆ ได้ ชุมชนสามารถสร้างฐานความรู้เพื่อเพิ่มทักษะ ข้อเท็จจริง และการใช้งาน พื้นที่แสดงวิธีการมีประโยชน์ 2 อย่าง ประการแรก ผู้ใช้ใหม่และผู้ใช้ที่มีประสบการณ์มีชุดเป้าหมายที่ชัดเจนสำหรับการทดสอบและสร้างการทดสอบ ประการที่ 2 ผู้ที่มีโอกาสเป็นผู้จัดทำเอกสารจะมีพื้นที่ในการสื่อสารเป้าหมาย วิธีการ และวิธีแก้ปัญหาของตนเอง พื้นที่วิธีการช่วยเติมเต็มความต้องการเร่งด่วนในการทําให้เอกสารประกอบของ NumPy เข้าถึงได้ง่ายขึ้นสําหรับผู้ใช้ใหม่และผู้ที่จะมีส่วนร่วมในอนาคต ความรู้ปัจจุบัน

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

พื้นที่ทำงานสำหรับเอกสารประกอบของซอฟต์แวร์ [3] แบ่งออกเป็น 4 กลุ่มใหญ่ๆ ได้แก่ พื้นที่ทำงานสำหรับบทแนะนำ พื้นที่ทำงานสำหรับวิธีการ พื้นที่ทำงานสำหรับคำอธิบาย และพื้นที่ทำงานสำหรับข้อมูลอ้างอิง เอกสารประกอบของ NumPy มีเอกสารจำนวนมากในพื้นที่บทแนะนำที่รวมคำอธิบายและเนื้อหาวิธีการจัดพื้นที่ลงในบทแนะนำ พื้นที่บทแนะนำควรมุ่งเน้นที่การให้ความรู้แก่ผู้ใช้ และใช้ขั้นตอนที่ทําซ้ำได้ง่ายเพื่อสื่อสารแนวคิด พื้นที่แสดงวิธีการมีขั้นตอนที่มุ่งเน้นเป้าหมายมากขึ้น ซึ่งผู้ใช้สามารถนำไปใช้ในชีวิตจริงได้ พื้นที่คำอธิบายจะให้รายละเอียดสตริงเอกสารในแต่ละฟังก์ชัน พื้นที่บทแนะนำและวิธีการปัจจุบันไม่ได้แบ่งอย่างชัดเจนและบางครั้งก็แทรกอยู่ในพื้นที่คำอธิบายและข้อมูลอ้างอิง มีบทแนะนำที่ยอดเยี่ยมสำหรับ "ผู้เริ่มต้นใช้งาน" และมีข้อมูลอ้างอิงที่ยอดเยี่ยมสำหรับผู้ใช้ Matlab ในการสร้างโค้ด NumPy ใน "Numpy สำหรับผู้ใช้ Matlab" การแยกพื้นที่ 4 ประเภทนี้อย่างชัดเจนทำให้เอกสารประกอบชัดเจนยิ่งขึ้น

ช่องว่างในฐานความรู้/ความต้องการที่ยังไม่บรรลุ

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

เหตุผล

โปรเจ็กต์ Google Summer of Docs นี้สำคัญต่อเป้าหมายด้านการเรียนการสอนและอาชีพของฉัน ฉันใช้ NumPy และ SciPy ในหลักสูตรทั้งหมด เอกสารประกอบปัจจุบันทำให้นักเรียนไปยังส่วนต่างๆ ได้ยาก ฉันต้องการใช้ประสบการณ์ในการสอนวิธีเขียนโค้ดให้กับผู้ที่ไม่ได้เรียนสาขาวิทยาการคอมพิวเตอร์เพื่อช่วยจัดระเบียบ แก้ไข และเติมเต็มช่องโหว่ในบทแนะนำที่มีอยู่ จากนั้นฉันจะใช้เอกสารประกอบเป็นตำราและเอกสารอ้างอิงสำหรับหลักสูตรของฉันได้ ฉันได้สร้างบทแนะนำ แบบฝึกหัด และตัวอย่างมากมายโดยใช้ Python และ ฉันต้องการแปลงเนื้อหาบางส่วนนี้ให้เป็นบทแนะนำและวิธีการ เรามีนักเรียนมากกว่า 800 คนที่ใช้ NumPy (เป็นส่วนหนึ่งของสแต็ก Scipy) และมีนักเรียนหลายคนที่สนใจเป็นผู้มีส่วนร่วมในเอกสารประกอบสำหรับภาคการศึกษาฤดูใบไม้ร่วง ฉันสอนวิศวกรรมเครื่องกลที่มหาวิทยาลัยคอนเนตทิคัตมา 4 ปีแล้ว และสอนหลักสูตรต่างๆ เป็นเวลากว่า 30 ชั่วโมงเครดิต

วัตถุประสงค์ที่เฉพาะเจาะจง

เรามีเป้าหมายที่เฉพาะเจาะจง 3 ข้อสำหรับข้อเสนอ Google Summer of Docs นี้ ดังนี้ 1. จัดระเบียบเอกสารปัจจุบัน 2. แก้ไขบทแนะนำปัจจุบัน (คำแนะนำสำหรับผู้เริ่มต้น การสร้างอาร์เรย์ การจัดทำดัชนี พีชคณิตเชิงเส้น และ NumPy สำหรับ Matlab) เพื่อย้ายข้อมูลอ้างอิงไปยังพื้นที่คำอธิบาย และ 3. สร้างเนื้อหาวิธีการกับนักเรียน เป้าหมายเฉพาะแต่ละข้อมีผลลัพธ์ที่คาดหวังสำหรับข้อเสนอ

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

ผลลัพธ์ที่คาดหวังมี 3 อย่างดังนี้ 1. หน้าเว็บเอกสารประกอบฉบับแก้ไขซึ่งแยกช่องว่างทั้ง 4 ด้านอย่างชัดเจน ได้แก่ บทแนะนำ วิธีการ คำอธิบาย และการอ้างอิง 2. บทแนะนำใหม่สำหรับการอ่านและการเขียนอาร์เรย์ การสร้างอาร์เรย์ (np.zeros, np.ones, np.block เป็นต้น) และการคำนวณ Element-wise เทียบกับ Linear ใน NumPy และ 3. การเว้นวรรคที่คัดสรรมาแล้ว

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

ผู้มีส่วนร่วมในเอกสารประกอบใหม่สามารถมีส่วนร่วมใน Use Case เล็กๆ กับผู้ใช้หลายล้านคนได้โดยไม่ต้องสร้างเอกสารประกอบ Sphinx ทั้งหมด เราอยากสร้างชุมชนการสอนและการเรียนรู้ต่อไป เอกสารที่เสนอนี้จะเลียนแบบเอกสารประกอบโอเพนซอร์สในปัจจุบัน เช่น Matplotlib, Divio เป็นต้น ผู้ใช้ใหม่และผู้ที่อาจมีส่วนร่วมจะเรียนรู้การใช้ NumPy ในสาขาและซอฟต์แวร์ของตนได้ง่ายขึ้น

ลำดับเวลาของโปรเจ็กต์คือ 14/9-30/11 ขั้นตอนแรกคือการสร้างเอกสารประกอบและแยกเนื้อหาในบทแนะนำปัจจุบันให้เป็นเนื้อหาบทแนะนำ วิธีการ และคำอธิบาย ซึ่งจะเสร็จสิ้นใน 5 สัปดาห์แรกของโครงการ โดยเป็นส่วนหนึ่งของผลลัพธ์ 1 และ 2 ในการแก้ไขเว็บไซต์และบทแนะนำตามลำดับ การจัดระเบียบเอกสารประกอบที่เสนอจะแสดงในเอกสารประกอบที่เสนอด้านล่าง

เอกสารที่นำเสนอ

i.Tutorials:

• ข้อมูลเบื้องต้นทั้งหมดสำหรับผู้เริ่มต้น (นำการติดตั้งออก สามารถแทนที่การนำเข้า/ส่งออก Pandas ด้วย numpy.loadtxt ได้ไหม)
• ลิงก์ไปยัง “หมายเลขคืออะไร”
• ลิงก์ไปยังวิธีการติดตั้งพื้นฐานที่นี่
• บทแนะนำการเริ่มต้นใช้งานฉบับย่อ (มีไว้สำหรับติดตามบทแนะนำ Python)
• การทำงานกับอาร์เรย์ NumPy
• การสร้างอาร์เรย์ (np.zeros, np.ones, np.block ฯลฯ) (เขียน: ลำดับความสำคัญปานกลาง-ต่ำ)
• การดำเนินการกับองค์ประกอบทีละรายการ (+,-,*,/) และการดำเนินการกับพีชคณิตเชิงเส้น (+,-,@, linalg.solve) (write:med priority)
• อ่านและเขียนข้อมูลโดยใช้ Numpy (เขียน: ลําดับความสําคัญสูง)
• การจัดทำดัชนี

2. วิธีการ

• พีชคณิตเชิงเส้นในอาร์เรย์ n มิติ (ต้องการแก้ไขส่วนหัวและคําอธิบาย และอาจเปลี่ยนชื่อเป็น "การประมวลผลภาพด้วยพีชคณิตเชิงเส้นของ Numpy")
• ลิงก์ไปยังเนื้อหาแสดงวิธีการของ numpy-tutorials (งานต่อเนื่อง)

3. คำอธิบาย:

• ประเภทข้อมูล
• I/O ด้วย Numpy
• การจัดทำดัชนี
• กำลังออกอากาศ
• การแลกเปลี่ยนไบต์
• อาร์เรย์ที่มีโครงสร้าง
• การเขียนคอนเทนเนอร์อาร์เรย์ที่กําหนดเอง
• คลาสย่อยของ ndarray
• เบ็ดเตล็ด

4. พื้นที่อ้างอิง:

• อภิธานศัพท์
• เอกสารอ้างอิง Numpy API
• Numpy สําหรับผู้ใช้ Matlab (ตารางความสอดคล้องเป็นตารางอ้างอิงที่ดี แต่การสนทนาเกี่ยวกับอาร์เรย์/เมทริกซ์จะทําให้เสียสมาธิและดูเหมือนว่าเลิกใช้งานแล้ว)

เมื่อจบ Google Season of Docs นี้ เราคาดหวังผลลัพธ์ต่อไปนี้

• หน้าเว็บเอกสารฉบับแก้ไขซึ่งแบ่งพื้นที่ทั้ง 4 ด้านอย่างชัดเจน ได้แก่ บทแนะนำ วิธีการ คำอธิบาย และข้อมูลอ้างอิง
• บทแนะนำใหม่สำหรับการสร้างอาร์เรย์ (np.zeros, np.ones, np.block ฯลฯ) การดำเนินการกับองค์ประกอบ (+,-,*,/) และการดำเนินการทางคณิตศาสตร์เชิงเส้น (+,-,@, linalg.solve) รวมถึงการอ่านและเขียนข้อมูลโดยใช้ Numpy (สำคัญมาก)
• เอกสารวิธีการที่แนะนำเพื่อเพิ่มการมีส่วนร่วมของผู้ใช้และช่วยส่งเสริมเป้าหมายของชุมชนในด้านการสอนและการเรียนรู้

ผลลัพธ์แต่ละรายการมีขั้นตอนที่ระบุไว้ด้านล่างในตารางสําหรับผลลัพธ์ 1-3 ในขณะที่มีการส่งเอกสารที่เสนอเพื่อการตรวจสอบ บทแนะนำ "อ่าน/เขียนอาร์เรย์" ที่มีลำดับความสำคัญสูงจะเขียนขึ้นสำหรับการส่งเป็นคำขอพุลซึ่งเป็นส่วนหนึ่งของผลลัพธ์ 2 ระหว่างการตรวจสอบเว็บไซต์ที่แก้ไขแล้วและอัปเดตบทแนะนำ "อ่าน/เขียนอาร์เรย์" ฉันจะเริ่มเขียนบทแนะนำการสร้างอาร์เรย์โดยใช้ฟังก์ชัน NumPy เช่น np.ones, np.zeros, np.diag เราจะใช้เวลาที่เหลือเพื่อตอบปัญหาเกี่ยวกับคำขอดึงข้อมูลและเริ่มเขียนบทแนะนำระดับ 3: การดำเนินการกับองค์ประกอบและการดำเนินการทางพีชคณิตเชิงเส้นใน Python

ผลลัพธ์ที่ 3 คือให้คำแนะนำแก่นักศึกษาที่มหาวิทยาลัยคอนเนตทิคัตในการสร้างเอกสารประกอบในที่เก็บ numpy-tutorials บทแนะนำหรือเอกสารวิธีการที่ส่งจะเป็นสมุดบันทึก Jupyter ที่ใช้ NumPy เพื่อแก้ปัญหาด้านวิศวกรรม ฉันจะใช้โน้ต/ตัวอย่างบางส่วนของหลักสูตรเพื่อส่งสมุดบันทึกตัวอย่าง ฉันจะแนะนำให้นักเรียนทำตามเลย์เอาต์และโครงสร้างขณะที่เราสร้างเทมเพลตและรูปแบบการจัดเฟรม ผลลัพธ์นี้ช่วยให้นักเรียนได้ถ่ายทอดแนวคิดและโซลูชันไปยังผู้ชมในวงกว้าง นี่เป็นโอกาสที่ดีสำหรับนักเรียนที่จะได้มีส่วนร่วมและเรียนรู้กับชุมชน NumPy

ผลลัพธ์ 1: แก้ไขวันที่ส่งมอบเว็บไซต์ แยกที่เก็บและสร้างเอกสารด้วย Sphinx 9/21 สร้างหน้าเว็บด้วย 4 Space ที่กำหนดและลิงก์ 10/1 ย้ายบทแนะนำปัจจุบันไปยังพื้นที่ที่เหมาะสมและสร้างเอกสาร 10/10 ส่ง PR ไปยัง github พร้อมการเปลี่ยนแปลงที่เสนอ 11/1 ตอบกลับความคิดเห็น/คำแนะนำ และแก้ไขผลลัพธ์ 13 ที่ดำเนินอยู่13

ผลลัพธ์ที่ 2: แก้ไขบทแนะนำ วันที่ส่งมอบ ตรวจสอบการจัดอันดับการแก้ไขบทแนะนำ 9/21 แยกเนื้อหาบทแนะนำปัจจุบันออกเป็นพื้นที่บทแนะนำและพื้นที่คำอธิบาย 10/1 เขียนระดับ 1: อาร์เรย์การอ่าน/เขียน 10/10 ส่ง PR ไปยัง github เพื่อแยกและแก้ไข 10/20 เขียน PR ระดับ 2: การสร้างอาร์เรย์ 11/15 เขียน PR ระดับ 3: การดำเนินการกับองค์ประกอบและการดำเนินการทางคณิตศาสตร์เชิงเส้น 11/30

การจัดอันดับการแก้ไขบทแนะนำที่เสนอ (อาจมีการเปลี่ยนแปลงตามผู้ให้คำปรึกษา/ชุมชน)

1. อ่าน/เขียนอาร์เรย์หน้าว่างในขณะนี้

2. การสร้างอาร์เรย์ (np.zeros, np.ones, np.block ฯลฯ) ไม่มี: จะช่วยให้ผู้ใช้ใหม่ได้รับคำอธิบายและสาธิตเครื่องมือการสร้าง/การโต้ตอบอาร์เรย์ทั่วไป

3. การดำเนินการกับองค์ประกอบและการดำเนินการทางคณิตศาสตร์เชิงเส้น (+,-,*,/ และ +,-@,linalg.solve) ไม่พร้อมใช้งาน: ซึ่งมีประโยชน์อย่างยิ่งสำหรับ 1. ผู้ใช้ Matlab และ 2. ผู้ที่นำมาใช้กับพีชคณิตเชิงเส้น (แมชชีนเลิร์นนิง รีเกรชันเชิงเส้น ฯลฯ)

ผลลัพธ์ที่ 3: พื้นที่สำหรับแสดงวิธีการที่ดูแลจัดการ วันที่ส่งมอบ ลิงก์ภายนอก(ปัญหา/ตัวอย่าง) สร้างตัวอย่างวิธีการ (ผู้สมัคร: วิธีหาความถี่ตามธรรมชาติของสายกีตาร์ 10/20
สร้างเทมเพลตวิธีการสำหรับผู้มีส่วนร่วมใหม่ 10/1 อยู่ระหว่างดำเนินการ การประชาสัมพันธ์เทมเพลตบทแนะนำและการกําหนดรูปแบบการมีส่วนร่วมที่เป็นไปได้ ทํางานร่วมกับผู้มีส่วนร่วมคนอื่นๆ เพื่อสร้างสมุดวิธีการเพื่อรับสมัครนักเรียน UConn และสมาชิกชุมชนคนอื่นๆ สถานะ 7/1: อนุมัติการฝึกงานและใบสมัครมาถึงแล้ว

ความสำคัญที่คาดหวัง

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

ข้อมูลอ้างอิง

1. เข้าถึงเว็บไซต์ NumPy.org เมื่อวันที่ 07/2020
2. ที่เก็บ NumPy GitHub
3. ระบบการจัดทำเอกสาร Divio.com ที่เข้าถึงเมื่อ 07/2020
4. Dewey, John ประชาธิปไตยและการศึกษา Project Gutenberg, ส. ค. 2015
5. Dewey, John Quest for Certainty George Allen And Unwin Limited. 06/2005