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