หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- Django
- นักเขียนเชิงเทคนิค
- Gabbyprecious
- ชื่อโปรเจ็กต์:
- เขียนคู่มือการเขียนใหม่เพื่อให้ใช้งานง่ายขึ้นและไปยังส่วนต่างๆ ได้ง่ายขึ้น
- ความยาวของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
ABSTRACT
เป้าหมายของคู่มือการมีส่วนร่วมของ Django เช่นเดียวกับเอกสารประกอบอื่นๆ ทั้งหมดคือเพื่อแนะนำผู้ใช้และผู้มีส่วนร่วมในโอเพนซอร์สในกรณีนี้เกี่ยวกับวิธีและตำแหน่งที่พวกเขาสามารถมีส่วนร่วมในการทำให้ Django ดีขึ้นและยั่งยืน
การสร้างเอกสารประกอบเป็นสิ่งจำเป็นเสมอ โดยเฉพาะเอกสารประกอบที่ส่งผลต่อชุมชนและ Django เองอย่างมาก
เป้าหมายของ Django สำหรับ Google Summer of Docs ในปีนี้คือทำให้คู่มือการมีส่วนร่วมเข้าใจง่ายขึ้น เข้าถึงได้ และยินดีต้อนรับผู้มีส่วนร่วม เป้าหมายนี้เป็นเป้าหมายที่สําคัญเนื่องจากเป็นการส่งเสริมผู้มีส่วนร่วม ซึ่งตัวฉันเองก็เป็นหนึ่งในผู้เริ่มต้นที่มีส่วนร่วมในเฟรมเวิร์กอันยอดเยี่ยมนี้
สถานะปัจจุบัน
ขั้นตอนปัจจุบันของเอกสารซึ่งสามารถดูได้ที่นี่นั้นไม่ใช่คู่มือมากนัก เนื่องจากมีข้อมูลมากเกินไป และไม่มีโครงสร้างที่ดี และทำให้มีความเข้าใจเกี่ยวกับการร่วมให้ข้อมูลใน Django น้อยลง และไม่ต้อนรับผู้ที่มีส่วนร่วมรายใหม่
เป้าหมายโปรเจ็กต์
เราได้พูดคุยเกี่ยวกับคำแนะนำสำหรับเอกสารประกอบกับที่ปรึกษาของฉัน Carlton Gibson ในฟอรัมแล้ว และเขาเห็นด้วยว่าคำแนะนำนี้จะช่วยแก้ปัญหาที่มากมายมหาศาลเกี่ยวกับเอกสารประกอบปัจจุบันได้ เป้าหมายที่เราวางแผนจะบรรลุจากการปรับเปลี่ยนโครงสร้างเอกสารมีดังนี้ ปรับเปลี่ยนโครงสร้างเอกสาร เพิ่มส่วน "ควรทำ" และ "ไม่ควรทำ" แบบเป็นหมวดหมู่ สร้างหน้าเว็บเดียวสำหรับส่วนที่ไม่สำคัญ เช่น การขอและสร้างฟีเจอร์ ลดจำนวนเอกสารประกอบและเน้นเนื้อหาที่ตรงประเด็น อภิธานศัพท์สำหรับคำต่างๆ ดัชนีภายในที่สร้างตามคู่มือใหม่ เขียนเอกสารประกอบที่เข้าใจง่ายยิ่งขึ้น แบ่งเนื้อหาออกเป็น 2 ส่วนหลัก (ส่วนผู้มีส่วนร่วมระดับเริ่มต้นและระดับสูง) สร้างคู่มือและรูปแบบสำหรับผู้เขียน/ผู้มีส่วนร่วมด้านเทคนิคคนใหม่ เพื่อให้เอกสารเป็นปัจจุบันและเป็นไปตามมาตรฐาน
เอกสารประกอบปัจจุบันมีไว้สำหรับผู้มีส่วนร่วมขั้นสูงอยู่แล้ว และไม่ได้เปิดโอกาสให้ผู้มีส่วนร่วมใหม่และผู้ที่เพิ่งเริ่มต้นทั้งกับโอเพนซอร์สและ Django เรียนรู้เนื้อหาเพิ่มเติม ต่อไปนี้คือเนื้อหาเพิ่มเติมสำหรับผู้เริ่มต้น ส่วนที่เป็นคำแนะนำสำหรับผู้มีส่วนร่วมกลุ่มต่างๆ(ผู้เขียนเนื้อหาทางเทคนิค นักออกแบบ และผู้พัฒนาซอฟต์แวร์) หน้าเว็บที่บันทึกปัญหาสำหรับผู้เริ่มต้นใช้งานและปัญหาง่ายๆ ที่แก้ไขได้ คัดลอกส่วนต่างๆ ในเอกสารประกอบปัจจุบันมาเขียนใหม่และเพิ่มลงในส่วนสำหรับผู้เริ่มต้น ส่วนต่างๆ ที่อธิบายประเด็นสำคัญหรือคําที่ใช้ในส่วนขั้นสูง
ไทม์ไลน์
ข้อมูลต่อไปนี้เป็นรายละเอียดเกี่ยวกับวิธีที่เราต้องการทำงานตามเป้าหมายของโปรเจ็กต์ตามที่ระบุไว้ข้างต้นด้วยปฏิทินที่ Google มีให้
สัปดาห์สานสัมพันธ์กับชุมชน( 17 สิงหาคม - 13 กันยายน) มีส่วนร่วมกับชุมชนมากขึ้น มีส่วนร่วมในเอกสารประกอบต่อไป รับคำแนะนำเพิ่มเติมจากผู้มีส่วนร่วม ศึกษาเอกสารประกอบปัจจุบันและเครื่องมือที่ต้องการใช้เพิ่มเติม สัปดาห์ที่ 1 - 4 เริ่มแบ่งส่วนเอกสารประกอบตามระดับ สร้างส่วนเอกสารประกอบสำหรับผู้เริ่มต้น สัปดาห์ที่ 4 - 6 ดูแลจัดการสิ่งที่ควรทำและไม่ควรทำ เขียนสิ่งที่ควรทำและไม่ควรทำในแต่ละส่วน หน้าเพิ่มเติมสำหรับแต่ละส่วน สัปดาห์ที่ 7 - 9 เขียนใหม่และย้ายเอกสารประกอบปัจจุบันไปยังคู่มือสำหรับผู้มีส่วนร่วมขั้นสูง ลดปริมาณเอกสารประกอบ สัปดาห์ที่ 10 - 12 เตรียมอภิธานศัพท์ อัปเดตดัชนีภายในเป็นเอกสารประกอบใหม่ สร้างคู่มือและรูปแบบสำหรับผู้เขียน/ผู้มีส่วนร่วมด้านเทคนิคที่เข้ามาใหม่
เครื่องมือ
Sphinx - เครื่องมือปัจจุบันสำหรับเอกสารปัจจุบัน อ่านเอกสาร
เหตุผลที่เลือกโปรเจ็กต์นี้
ฉันเชื่ออย่างยิ่งว่าเอกสารประกอบและบทความที่เขียนมาอย่างดีจะครอบคลุมทุกคนในโลก นอกจากนี้ ฉันยังชื่นชอบ Django และโอเพนซอร์สโดยรวมด้วย ฉันตั้งใจที่จะมีส่วนร่วมใน Django ในฐานะผู้เริ่มต้น และคิดว่านี่เป็นวิธีที่ยอดเยี่ยมในการมีส่วนร่วมกับเครื่องมือที่ฉันชื่นชอบ ในขณะเดียวกันก็ทำความคุ้นเคยกับโค้ดเบสเพื่อมีส่วนร่วมมากขึ้นในฐานะนักพัฒนาซอฟต์แวร์(และนักเขียนด้านเทคนิค) การได้ร่วมงานกับองค์กรที่สอดคล้องกับมุมมองของฉันและถือเป็นเครื่องมือที่ยอดเยี่ยมตลอดเส้นทางอาชีพของฉันนับเป็นประสบการณ์ที่ยอดเยี่ยม
เหตุใดฉันจึงเป็นบุคคลที่เหมาะสมสำหรับโปรเจ็กต์นี้
ฉันคิดว่าฉันเป็นบุคคลที่เหมาะสมโดยอิงจากบัญชีต่อไปนี้ ฉันมีส่วนร่วมกับ Django ด้วยการเขียนบทความเพื่อช่วยให้ผู้เริ่มต้นเข้าใจแนวคิดของ Django มากขึ้น ในฐานะที่เป็นนักพัฒนาซอฟต์แวร์และต้องการที่จะให้ความช่วยเหลือแก่ Django ด้วย ทำให้ฉันเข้าใจความต้องการของเพื่อนนักพัฒนาซอฟต์แวร์คนอื่นๆ และวิธีการจัดทำเอกสารประกอบให้ดีสำหรับพวกเขา ฉันเป็นผู้เล่นในทีมและจะทํางานได้ดีภายใต้การควบคุมดูแลน้อยหรือมากของที่ปรึกษา Carlton Gibson