ระยะปัจจุบัน:
โปรแกรม Season of Docs ปี 2019 จบลงแล้วเมื่อวันที่ 6 มีนาคม 2020 ดูไทม์ไลน์
หน้านี้มีคำแนะนำสำหรับนักเขียนด้านเทคนิคที่เข้าร่วมซีซันของเอกสาร
เกริ่นนำ
ยินดีต้อนรับสู่ Season of Docs! คู่มือนี้จะให้ข้อมูลเล็กๆ น้อยๆ เกี่ยวกับการเข้าร่วมในซีซันของเอกสาร และช่วยเหลือคุณเกี่ยวกับกิจกรรมที่คุณควรดำเนินการในแต่ละระยะของโปรแกรม
สิทธิ์ในการเข้าร่วมซีซันของเอกสาร
หากต้องการเข้าร่วมในซีซันของเอกสารในฐานะนักเขียนด้านเทคนิค คุณต้องมีคุณสมบัติดังนี้
- มีอายุอย่างน้อย 18 ปีบริบูรณ์ ณ วันที่จดทะเบียน
- สามารถแสดงประสบการณ์การเขียนเชิงเทคนิคที่มีมาก่อนหน้านี้โดยการส่งคำอธิบายบทบาทและตัวอย่างงาน
- มีสิทธิ์ทำงานในประเทศที่พำนักในช่วงระยะเวลาของโปรแกรม
- เป็นผู้พำนักอาศัยในประเทศที่ไม่ได้ถูกคว่ำบาตรโดยสหรัฐอเมริกา ดูโปรแกรมการคว่ำบาตรและข้อมูลประเทศจากกระทรวงการคลังสหรัฐฯ
ดูคำศัพท์ทางเทคนิคสำหรับนักเขียน
ที่ปรึกษาโอเพนซอร์สของคุณ
ซีซันของเอกสาร Mentor ไม่จำเป็นต้องเป็นนักเขียนด้านเทคนิคเสมอไป และอาจไม่มีประสบการณ์ด้านการสื่อสารเชิงเทคนิคเลย พวกเขาเป็นสมาชิกขององค์กรโอเพนซอร์สที่รู้จักคุณค่าของเอกสารประกอบที่ดี ตลอดจนมีประสบการณ์ในด้านเครื่องมือและกระบวนการโอเพนซอร์ส
ความสัมพันธ์ระหว่างคุณกับ Mentor คือการทำงานร่วมกัน คุณนำทักษะและประสบการณ์การใช้งานเอกสารประกอบมาสู่องค์กรโอเพนซอร์สได้ Mentor ให้ความรู้เกี่ยวกับโอเพนซอร์สและโค้ด เมื่อร่วมมือกัน คุณจะพัฒนาเอกสารทางเทคนิคและปรับปรุงกระบวนการของโครงการโอเพนซอร์สได้
ช่วงการประกาศของโปรแกรมและช่วงการสมัครขององค์กร
วันที่ประกาศซีซันของเอกสารคือ 11 มีนาคม 2019 องค์กรโอเพนซอร์สที่สนใจสามารถสมัครเข้าร่วมซีซันของเอกสารระหว่างวันที่ 2 เมษายน 2019 ถึง 23 เมษายน 2019 ได้ ผู้ดูแลระบบโปรแกรมของ Google จะเผยแพร่รายชื่อองค์กรที่ประสบความสำเร็จ ในวันที่ 30 เมษายน 2019
ในระหว่างช่วงเวลาการประกาศของโปรแกรมกับการเผยแพร่ ขององค์กรโอเพนซอร์สที่เข้าร่วม คุณควรเฝ้าติดตามข่าวสาร คุณสามารถกลับมาที่เว็บไซต์นี้เพื่อดูบล็อกโพสต์หรือข่าวอื่นๆ บนเว็บได้ องค์กรโอเพนซอร์สบางแห่งอาจแชร์แนวคิดแม้ในช่วงการสมัครขององค์กร
นอกจากนี้ เราขอเชิญให้คุณบอกต่อเกี่ยวกับซีซันของเอกสารและเหตุผลที่คุณสนใจโปรแกรมนี้ ลองดูเนื้อหาสำหรับการโปรโมตเพื่อหากราฟิกและไอเดียต่างๆ
ช่วงการสำรวจผู้เขียนด้านเทคนิค
ขั้นตอนการสำรวจผู้เขียนด้านเทคนิคคือตั้งแต่วันที่ 30 เมษายน - 28 พฤษภาคม 2019 ในระยะเวลานี้ คุณสามารถสำรวจรายชื่อ องค์กรที่เข้าร่วมและแนวคิดของโครงการ
เมื่อพบโปรเจ็กต์ที่คุณสนใจอย่างน้อย 1 โปรเจ็กต์ คุณควรติดต่อองค์กรโอเพนซอร์สที่เกี่ยวข้องโดยตรงเพื่อพูดคุยเกี่ยวกับแนวคิดของโครงการ
| งานของคุณในฐานะนักเขียนด้านเทคนิคในระยะนี้ | |
|---|---|
|
ดูรายชื่อองค์กรโอเพนซอร์สที่เข้าร่วมและแนวคิดเกี่ยวกับโปรเจ็กต์ขององค์กรเหล่านี้ |
ตรวจสอบรายชื่อเพื่อค้นหาองค์กรโอเพนซอร์สที่คุณต้องการร่วมงานด้วย ดูโปรเจ็กต์การเขียนเชิงเทคนิคที่องค์กรต่างๆ เสนอแล้วตัดสินใจว่าโปรเจ็กต์ไหนเหมาะกับคุณ คุณอาจสมัครได้มากกว่า 1 องค์กร ในขั้นของ Season of Docs เราขอแนะนำให้คุณสำรวจตัวเลือกมากกว่า 1 รายการ ขั้นตอนการคัดเลือกขั้นสุดท้ายยอมรับเพียง 1 โปรเจ็กต์ต่อผู้เขียนด้านเทคนิค 1 ราย |
|
พูดคุยเรื่องไอเดียของโครงการกับองค์กรโอเพนซอร์ส |
คุณอาจหารือเกี่ยวกับแนวคิดของโปรเจ็กต์กับองค์กรที่เข้าร่วม หากต้องการติดต่อ ให้ใช้อีเมลขององค์กรที่แสดงในรายชื่อองค์กรที่เข้าร่วม การพูดคุยในช่วงแรกจะช่วยให้คุณรวบรวมข้อเสนอโปรเจ็กต์ที่ดีเพื่อส่งไปให้ผู้ดูแลระบบโปรแกรม Google ในระยะสมัครเป็นนักเขียนด้านเทคนิค แนวคิดของโครงการเบื้องต้นอาจมาจากรายการแนวคิดที่องค์กรได้เสนอไว้ คุณอาจเสนอไอเดียของคุณเองได้เช่นกัน |
ขั้นการสมัครผู้เขียนด้านเทคนิค
ขั้นตอนการสมัครสำหรับนักเขียนด้านเทคนิคเริ่มตั้งแต่ 29 พฤษภาคม 2019 - 28 มิถุนายน 2019 ในระหว่างนี้คุณสามารถสมัครเข้าร่วมซีซันของเอกสารได้ ผู้ดูแลระบบโปรแกรมของ Google จะส่งต่อรายละเอียดที่เกี่ยวข้องจากแอปพลิเคชันของคุณไปยังองค์กรโอเพนซอร์สที่คุณเลือก จากนั้นผู้ดูแลระบบองค์กรแบบโอเพนซอร์สและ Mentor จะเลือกโครงการที่ต้องการเป็นที่ปรึกษา
| งานของคุณในฐานะผู้สมัครนักเขียนด้านเทคนิคในระยะนี้ | |
|---|---|
|
ส่งใบสมัครเพื่อเข้าร่วม Season of Docs |
ส่งใบสมัครสำหรับฤดูกาลของเอกสารก่อนวันที่ 28 มิถุนายน 2019 เราปิดรับสมัครผู้เขียนด้านเทคนิคประจำซีซัน 2019 แล้ว |
ระยะสานสัมพันธ์ในชุมชน
ระยะผูกมัดของชุมชนมีขึ้นตั้งแต่วันที่ 7 สิงหาคม - 1 กันยายน 2019 ในช่วงเวลานี้ ที่ปรึกษาโอเพนซอร์สจะช่วยให้คุณคุ้นเคยกับโครงการและชุมชนโอเพนซอร์ส
| งานของคุณในฐานะนักเขียนด้านเทคนิคในระยะนี้ | |
|---|---|
|
กำหนดช่องทางการสื่อสาร |
ติดต่อที่ปรึกษาในองค์กรโอเพนซอร์สที่คุณเลือกทำงานด้วย คุณต้องมีวิธีที่เชื่อถือได้ในการสื่อสารกับที่ปรึกษาโดยตรงและกับผู้ดูแลระบบองค์กร คนหลังคือสมาชิกขององค์กรโอเพนซอร์สที่ทำหน้าที่เป็นผู้ติดต่อหลักของเอกสารในซีซันขององค์กร คู่มือสำหรับที่ปรึกษา เกี่ยวกับการทำงานร่วมกับนักเขียนด้านเทคนิค |
|
เข้ามามีส่วนร่วมในโครงการโอเพนซอร์สและชุมชน |
ถามคำถามที่ปรึกษาเกี่ยวกับเครื่องมือและกระบวนการที่องค์กรโอเพนซอร์สใช้ แนะนำตัวเองในรายชื่ออีเมลของชุมชนโอเพนซอร์ส, แชท, ช่อง Slack และช่องทางการสื่อสารอื่นๆ ที่แชร์ร่วมกัน |
|
ทำความเข้าใจผลิตภัณฑ์โดยรวม |
ขอให้ที่ปรึกษาอธิบายผลิตภัณฑ์ (โดยเฉพาะในเชิงแนวคิด) ที่คุณจะจัดทำเป็นเอกสารในเร็วๆ นี้ พูดคุยรายละเอียดเกี่ยวกับกลุ่มเป้าหมายของเอกสาร |
|
ตั้งเป้าหมายและความคาดหวัง |
ทำงานร่วมกับที่ปรึกษาเพื่อปรับแต่งเป้าหมายสำหรับโปรเจ็กต์การเขียนเชิงเทคนิคและเพื่อกำหนดความคาดหวังของทั้ง 2 ฝ่าย การตั้งเป้าหมายและความคาดหวังเหล่านี้ตั้งแต่ตอนนี้เป็นวิธีที่ดีในการทำให้โปรเจ็กต์ประสบความสำเร็จ |
ระยะการพัฒนาเอกสาร
ระยะการพัฒนาเอกสารเริ่มตั้งแต่ 2 กันยายน 2019 - 22 พฤศจิกายน 2019 (วันที่สิ้นสุดจะแตกต่างกันสำหรับโครงการที่ใช้เวลานาน) ในช่วงเวลานี้ คุณจะทำโปรเจ็กต์ร่วมกับที่ปรึกษาอย่างใกล้ชิด
| งานของคุณในฐานะนักเขียนด้านเทคนิคในระยะนี้ | |
|---|---|
|
ทำงานร่วมกับ Mentor เพื่อดำเนินโครงการให้เสร็จสมบูรณ์ |
ทำงานร่วมกับที่ปรึกษาอย่างใกล้ชิดเพื่อให้โครงการของคุณเสร็จสมบูรณ์ ทำตามขั้นตอนของชุมชนโอเพนซอร์สเพื่อขอตรวจสอบเอกสารที่ได้และส่งการอัปเดตไปยังที่เก็บโอเพนซอร์ส ตัวอย่างเช่น โปรเจ็กต์โอเพนซอร์สที่โฮสต์อยู่ใน GitHub จะเพิ่มหรืออัปเดตไฟล์โดยการสร้างคำขอแบบพุลสำหรับการตรวจสอบและส่ง |
|
โปรดแจ้งข้อกังวลกับผู้ดูแลระบบองค์กร |
หากมีข้อกังวลเกี่ยวกับการสื่อสารกับ Mentor หรือพบปัญหาอื่นๆ ที่อาจส่งผลต่อการดำเนินโปรเจ็กต์ให้เสร็จสมบูรณ์ โปรดแจ้งให้ผู้ดูแลระบบขององค์กรโอเพนซอร์สทราบ |
|
ตอบแบบสำรวจจากผู้ดูแลระบบโปรแกรม Google |
ผู้ดูแลระบบโปรแกรมของ Google อาจส่งแบบสำรวจกลางโปรเจ็กต์เพื่อประเมินความคืบหน้า ตอบแบบสำรวจและส่งคำตอบให้ผู้ดูแลระบบโปรแกรม Google ตามที่กำหนดไว้ในเอกสารแบบสำรวจ |
ระยะสรุปและประเมินโครงการ
ช่วงสรุปโปรเจ็กต์มีขึ้นตั้งแต่วันที่ 25-29 พฤศจิกายน 2019 และระยะประเมินจะเริ่มต้นตั้งแต่วันที่ 25 พฤศจิกายน - 6 ธันวาคม 2019 (วันที่ของโครงการที่ใช้เวลานานจะแตกต่างออกไป) ในช่วงสรุปโปรเจ็กต์ คุณต้องส่งรายงานโปรเจ็กต์หรือเรียกอีกอย่างว่าผลิตภัณฑ์สำหรับงานขั้นสุดท้าย ในระหว่างขั้นตอนการประเมิน คุณสามารถส่งการประเมินผลของที่ปรึกษาและประสบการณ์ของคุณในฐานะผู้เข้าร่วมในซีซันของเอกสาร
| งานของคุณในฐานะนักเขียนด้านเทคนิคในระยะนี้ | |
|---|---|
|
เขียนรายงานโครงการ |
เขียนรายงานโปรเจ็กต์ (บางครั้งเรียกว่าผลิตภัณฑ์สำหรับการทำงาน) รายงานโปรเจ็กต์มีคำอธิบายงานที่คุณทำในระหว่างฤดูกาลของเอกสารและลิงก์ที่เกี่ยวข้อง ขั้นตอนการสรุปโปรเจ็กต์สำหรับซีซัน 2019 ของเอกสารได้สิ้นสุดลงแล้ว |
|
ขอให้ Mentor ตรวจสอบรายงานโปรเจ็กต์ |
ที่ปรึกษาอาจมีข้อมูลเชิงลึกที่มีค่าเกี่ยวกับวิธีอธิบายความสำเร็จของคุณ นอกจากนี้ การทำความเข้าใจสถานะของโปรเจ็กต์ร่วมกันก็มีประโยชน์ในขั้นตอนนี้ ก่อนที่ที่ปรึกษาจะทำเครื่องหมายโปรเจ็กต์ว่าเสร็จสมบูรณ์หรือไม่ |
|
สรุปรายงานโปรเจ็กต์ |
จัดทำรายงานโปรเจ็กต์ให้เสร็จสิ้นภายในวันที่ 28 กุมภาพันธ์ 2020 เวลา 18:00 น. (UTC) แบบฟอร์มนี้แก้ไขได้ แต่คุณต้องส่งเวอร์ชันสุดท้ายภายในวันที่ที่ระบุ ขั้นตอนการสรุปโปรเจ็กต์สำหรับซีซัน 2019 ของเอกสารได้สิ้นสุดลงแล้ว |
|
เขียนและส่งการประเมินที่ปรึกษาของคุณและประสบการณ์การใช้งาน Season of Docs |
กรอกและส่งการประเมินภายในวันที่ 28 กุมภาพันธ์ 2020 เวลา 18:00 น. ตามเขตเวลา UTC การประเมินโดยนักเขียนด้านเทคนิค ขั้นตอนการสรุปโปรเจ็กต์สำหรับซีซัน 2019 ของเอกสารได้สิ้นสุดลงแล้ว |
โครงการที่ดำเนินมายาวนาน
สำหรับโครงการเขียนเชิงเทคนิคที่มีความยาวมาตรฐานในซีซันของเอกสาร ระยะการพัฒนาเอกสารจะเริ่มตั้งแต่วันที่ 2 กันยายน 2019 - 22 พฤศจิกายน 2019 อย่างไรก็ตาม นักเขียนด้านเทคนิคบางคนอาจสมัครเข้าร่วมโปรเจ็กต์ที่ดำเนินมายาวนานภายใต้การปรึกษากับองค์กรโอเพนซอร์ส โปรเจ็กต์ที่ดำเนินมายาวนาน ระยะการพัฒนาเอกสารจะเริ่มตั้งแต่วันที่ 2 กันยายน 2019 - 21 กุมภาพันธ์ 2020
การสรุปโครงการและระยะเวลาประเมินสำหรับโปรเจ็กต์ระยะยาวคือวันที่ 24-28 กุมภาพันธ์ 2020
งานและความรับผิดชอบของคุณจะเหมือนกับที่อธิบายไว้ในหน้านี้สำหรับโครงการเขียนทางเทคนิคที่มีความยาวมาตรฐาน ยกเว้นวันที่สรุปและประเมินโครงการจะเป็นวันที่ภายหลัง
ข้อมูลที่เกี่ยวข้อง
- ดูไทม์ไลน์ของซีซันของเอกสาร
- ดูข้อมูลเพิ่มเติมเกี่ยวกับความสัมพันธ์ของคุณกับองค์กรโอเพนซอร์สที่เลือกโดยอ่านความรับผิดชอบของผู้ดูแลระบบและที่ปรึกษาขององค์กร รวมถึงหลักเกณฑ์สำหรับที่ปรึกษาเกี่ยวกับการทำงานร่วมกับนักเขียนด้านเทคนิค