ระยะปัจจุบัน:
การสรุปโปรเจ็กต์ ดูไทม์ไลน์
ใช้คู่มือนี้เป็นเทมเพลตในการสร้างข้อเสนอโปรเจ็กต์ขององค์กร
ชื่อคําเสนอ - ชื่อองค์กร
ชื่อโปรเจ็กต์ควรสั้นและเฉพาะเจาะจง "คำแนะนำในการอัปเดตคู่มือสำหรับผู้มีส่วนร่วมของ ORGNAME" เป็นชื่อข้อเสนอที่ดี "การปรับปรุงเอกสารประกอบ" คลุมเครือเกินไป ส่วน "อัปเดตส่วนที่ 5,7,23,99 ของคู่มือสำหรับผู้มีส่วนร่วม สร้างคําถามที่พบบ่อย และสร้างคู่มือสไตล์" ยาวเกินไป
เกี่ยวกับองค์กรของคุณ
ในส่วนนี้ โปรดบอกเราเกี่ยวกับองค์กรหรือโปรเจ็กต์ของคุณในย่อหน้าสั้นๆ 2-3 ย่อหน้า โปรเจ็กต์ของคุณช่วยแก้ปัญหาอะไรได้บ้าง ผู้ใช้และผู้มีส่วนร่วมของคุณคือใคร องค์กรหรือโปรเจ็กต์ของคุณก่อตั้งมานานเท่าใด ระบุบริบทเพื่อช่วยให้เราเข้าใจว่าเหตุใดการให้เงินสนับสนุนโปรเจ็กต์ของคุณจึงจะสร้างผลกระทบเชิงบวกต่อโอเพนซอร์สและโลกใบนี้
GloriousPickle (เวอร์ชันปัจจุบันคือ 1.2.3 เผยแพร่ครั้งแรกในปี 2009) เป็นไลบรารีที่ได้รับอนุญาตจาก MIT สำหรับคำนวณสัดส่วนที่เหมาะสมของเกลือ น้ำตาล น้ำส้มสายชู และเครื่องเทศสำหรับผักทุกชนิดที่อาจทำเป็นผักดองได้ ไม่ว่าจะมีปริมาณมากน้อยเพียงใด ตั้งแต่แตงกวาขี้เหร่ตัวเดียวไปจนถึงหัวไชเท้าเต็มตู้คอนเทนเนอร์ ผู้มีส่วนร่วมของเราคือผู้ที่ชื่นชอบการดองผักและผลไม้จากทั่วโลก ส่วนผู้ใช้ของเราคือเชฟในบ้าน เชฟร้านอาหาร และผู้ที่ทำงานด้านโลจิสติกส์ให้กับบริษัทและองค์กรแปรรูปอาหารขนาดใหญ่ ผู้ใช้รายใหญ่ที่สุดของเราคือองค์กรที่ช่วยธนาคารอาหารเปลี่ยนผักที่มีอายุการเก็บรักษาสั้นๆ ให้กลายเป็นกระปุกผักดองที่มีอายุการเก็บรักษานาน เพื่อช่วยเลี้ยงอาหารแก่ผู้ที่อดอยากในชุมชนต่างๆ และลดการสูญเสียอาหาร นอกจากนี้ ผู้ใช้ยังส่งเมตริกที่ไม่บังคับเกี่ยวกับการใช้ GloriousPickle ให้เราด้วย ซึ่งเราใช้เพื่อสร้าง PickleSet ซึ่งเป็นชุดข้อมูลขนาดใหญ่สําหรับสร้างสูตรการดองแบบใหม่ผ่านแมชชีนเลิร์นนิง
เกี่ยวกับโปรเจ็กต์ของคุณ
ปัญหาของโปรเจ็กต์
บอกเราเกี่ยวกับปัญหาที่โปรเจ็กต์จะช่วยแก้ปัญหา เหตุใดองค์กรหรือโปรเจ็กต์ของคุณจึงต้องแก้ปัญหานี้
ผู้ใช้ต้องการเพิ่มข้อมูลเกี่ยวกับเครื่องเทศใหม่ๆ และส่วนผสมอื่นๆ (โดยเฉพาะส่วนผสมจากอาหารที่ไม่ได้มาจากยุโรป) ลงในเครื่องมือ GloriousPickle ขออภัย กระบวนการเพิ่มข้อมูลนี้ไม่มีเอกสารประกอบที่ดีนัก ซึ่งหมายความว่าผู้ที่จะมีส่วนร่วมต้องเปิดปัญหาในโปรเจ็กต์เพื่อรับความช่วยเหลือ (หรืออาจเลิกพยายามไปเลย) กระบวนการนี้ยังถือว่าผู้มีส่วนร่วมคุ้นเคยกับกระบวนการดึงคำขอและ GitHub อยู่แล้ว แม้ว่าผู้ใช้จำนวนมากของเราจะไม่ใช่นักพัฒนาซอฟต์แวร์มืออาชีพก็ตาม
ยิ่งเรามีข้อมูลส่วนผสมมากเท่าไร GloriousPickle ก็จะยิ่งมีประโยชน์ต่อผู้ใช้ทุกคนมากขึ้นเท่านั้น
ขอบเขตของโปรเจ็กต์
บอกเราเกี่ยวกับเอกสารที่องค์กรจะสร้าง อัปเดต หรือปรับปรุง หากจงใจไม่ทำงานบางอย่าง ให้ระบุข้อมูลดังกล่าวด้วย ระบุเวลาโดยประมาณ และระบุว่าคุณได้ระบุอาสาสมัครขององค์กรและผู้เขียนเนื้อหาทางเทคนิคที่จะทำงานร่วมกับโปรเจ็กต์ของคุณแล้วหรือยัง
โปรเจ็กต์ GloriousPickle (ชื่อรหัส PicklePlus) จะทําสิ่งต่อไปนี้
- ตรวจสอบเอกสารประกอบที่มีอยู่และสร้างบันทึกการขัดข้องของเอกสารประกอบปัจจุบันสำหรับกรณีการใช้งาน 3 อันดับแรก (การเพิ่มส่วนผสมใหม่ การเพิ่มส่วนผสมย่อย และอัปเดตหรือแก้ไขข้อมูลเกี่ยวกับส่วนผสม)
- ใช้บันทึกการขัดข้องเป็นแนวทางในการทำความเข้าใจช่องโหว่ในเอกสารประกอบ สร้างเอกสารประกอบที่อัปเดตแล้วสำหรับ Use Case ยอดนิยม
- สร้าง "เคล็ดลับ" สั้นๆ เพื่อช่วยให้ผู้มีส่วนร่วมที่เพิ่งเริ่มใช้การดึงคำขอและ GitHub สามารถใช้กระบวนการของเราได้
- รวบรวมความคิดเห็นจากผู้ทดสอบเอกสารประกอบ (อาสาสมัครในโปรเจ็กต์) และชุมชน GloriousPickle ในวงกว้าง
- ทำงานร่วมกับทีมเผยแพร่เพื่ออัปเดตเอกสารประกอบในเว็บไซต์ GloriousPickle และสร้างกระบวนการเพื่อทำให้เอกสารประกอบสอดคล้องกับเครื่องมืออัปเดตในอนาคต
งานที่ไม่อยู่ในขอบเขตของโปรเจ็กต์นี้
- โปรเจ็กต์นี้จะไม่สร้างกระบวนการเชื่อมโยงข้ามระหว่างการสะกดหรือชื่อที่แตกต่างกันสำหรับส่วนผสมเดียวกัน
- โปรเจ็กต์นี้จะไม่สร้างบทแนะนำ GitHub แต่จะใช้ชีตเคล็ดลับลิงก์ไปยังเนื้อหาที่มีอยู่ซึ่งมีความเกี่ยวข้องและเป็นประโยชน์แทน
เรามีผู้สมัครเขียนเนื้อหาทางเทคนิคที่เก่ง 2 คนสำหรับโปรเจ็กต์นี้ และคาดว่างานนี้จะใช้เวลา 3 เดือนจึงจะเสร็จสมบูรณ์ GloriousPickle PickleDocs SIG และ @GloriousPicklePat (ผู้ดูแลหลักของ API การเพิ่มส่วนผสม) ได้มุ่งมั่นที่จะสนับสนุนโปรเจ็กต์นี้
การวัดความสําเร็จของโปรเจ็กต์
คุณจะรู้ได้อย่างไรว่าเอกสารใหม่ช่วยแก้ปัญหาของคุณได้ คุณจะใช้เมตริกใดและจะติดตามเมตริกเหล่านั้นอย่างไร
GloriousPickle ได้รับคำขอดึงข้อมูลโดยเฉลี่ย 10 รายการต่อไตรมาสเพื่อเพิ่มหรืออัปเดตส่วนผสมใหม่ (ติดแท็ก "ingredient") คำขอดึงข้อมูลส่วนใหญ่ (>60%) เหล่านี้มาจากผู้มีส่วนร่วมก่อนหน้านี้ เราเชื่อว่าเอกสารประกอบที่ปรับปรุงใหม่นี้จะทำให้ได้รับคำขอดึงข้อมูลมากขึ้นและคำขอดึงข้อมูลจากผู้มีส่วนร่วมใหม่มากขึ้น เนื่องจากผู้มีส่วนร่วมที่ใช้งานอยู่ส่วนใหญ่ของเราเริ่มต้นด้วยการเพิ่มส่วนผสม เราจึงคิดว่าการปรับปรุงเอกสารประกอบนี้จะทำให้มีผู้มีส่วนร่วมที่ใช้งานอยู่มากขึ้นโดยรวม
เราจะติดตามเมตริก 2 รายการ (จำนวนคำขอดึงข้อมูลที่เกี่ยวข้องกับส่วนผสมและจำนวนคำขอดึงข้อมูลจากผู้มีส่วนร่วมรายใหม่) เป็นรายเดือนหลังจากเผยแพร่เอกสารประกอบ นอกจากนี้ เราจะติดตามจํานวนผู้มีส่วนร่วมที่มีส่วนร่วมมากกว่า 3 ครั้งโดยรวม โดยจะเริ่มทุกไตรมาสหลังจากเผยแพร่เอกสารประกอบ
เราจะถือว่าโปรเจ็กต์ประสบความสำเร็จหากหลังจากเผยแพร่เอกสารประกอบใหม่แล้ว
- จำนวนคำขอดึงที่เกี่ยวข้องกับส่วนผสมเพิ่มขึ้น 20%
- จำนวนคำขอดึงข้อมูลจากผู้มีส่วนร่วมใหม่เพิ่มขึ้น 15%
- จำนวนผู้มีส่วนร่วมที่มีส่วนร่วมมากกว่า 3 ครั้งเพิ่มขึ้น 10% (เริ่มตั้งแต่ไตรมาสหลังจากที่เผยแพร่เอกสารประกอบ)
ไทม์ไลน์
คุณคาดว่างานนี้จะใช้เวลานานเท่าใด คุณแจกแจงงานของนักเขียนด้านเทคโนโลยีเป็นรายเดือนหรือรายสัปดาห์ได้ไหม
โปรเจ็กต์นี้เองจะใช้เวลาประมาณ 6 เดือนจึงจะเสร็จสมบูรณ์ เมื่อจ้างนักเขียนเทคโนโลยีแล้ว เราจะใช้เวลา 1 เดือนในการปฐมนิเทศนักเขียนเทคโนโลยี จากนั้นจะเข้าสู่ขั้นตอนการตรวจสอบและบันทึกปัญหา และใช้เวลา 2-3 เดือนสุดท้ายในการจัดทำเอกสารประกอบ
| วันที่ | รายการการทำงาน |
|---|---|
| พฤษภาคม | การวางแนว |
| มิถุนายน - สิงหาคม | ตรวจสอบเอกสารประกอบที่มีอยู่และสร้างบันทึกการขัดข้อง |
| กันยายน - ตุลาคม | สร้างเอกสารประกอบ |
| พฤศจิกายน | เสร็จสิ้นโปรเจ็กต์ |
งบประมาณโปรเจ็กต์
หลักเกณฑ์ทั่วไป
- คุณสามารถระบุงบประมาณในข้อเสนอหรือเป็นลิงก์แยกต่างหากก็ได้ หากงบประมาณมีรายการน้อยกว่า 10 รายการ เราขอแนะนำให้ระบุงบประมาณในข้อเสนอ
- งบประมาณทั้งหมดควรเป็นสกุลเงินดอลลาร์สหรัฐ เราคาดว่าเงินสนับสนุนจะอยู่ที่ประมาณ US$5,000 ถึง US$15,000 หากโปรเจ็กต์ของคุณอยู่นอกช่วงดังกล่าว โปรดระบุข้อมูลเพิ่มเติมเพื่ออธิบายงบประมาณ
- เราคาดว่างบประมาณส่วนใหญ่ (ขั้นต่ำ 60-70%) ของคุณจะจัดสรรให้กับนักเขียนด้านเทคนิคที่ทำงานในโปรเจ็กต์ เราขอแนะนําให้กําหนดงบประมาณตามโปรเจ็กต์เมื่อเป็นไปได้
- เราคาดหวังว่าโปรเจ็กต์โอเพนซอร์สจะใช้เครื่องมือโอเพนซอร์สทุกครั้งที่เป็นไปได้ หากโปรเจ็กต์ของคุณต้องใช้เงินทุนสำหรับใบอนุญาตซอฟต์แวร์ที่เป็นกรรมสิทธิ์หรือการสนับสนุนอย่างหลีกเลี่ยงไม่ได้ ให้ระบุเหตุผลที่ต้องใช้เงินจำนวนดังกล่าว
- ค่าใช้จ่ายอื่นๆ ที่เป็นไปได้ ได้แก่
- งานออกแบบเพื่อสร้างการสร้างแบรนด์ โลโก้ เทมเพลต หรือชิ้นงานการออกแบบอื่นๆ สำหรับเว็บไซต์เอกสารประกอบ
- ค่าใช้จ่ายขั้นต่ำ (<US$200) สำหรับของสมนาคุณของโปรเจ็กต์ (เสื้อยืดหรือสติกเกอร์สำหรับผู้เข้าร่วม) หากใช้โลโก้ Google Season of Docs โลโก้ดังกล่าวต้องมาพร้อมกับโลโก้หรือชื่อโปรเจ็กต์หรือองค์กรของคุณ ของที่ระลึกต้องไม่ใช้ชื่อ Google
- ค่าตอบแทนขั้นต่ำสำหรับอาสาสมัครที่ทำหน้าที่เป็นพี่เลี้ยงหรือให้คำแนะนำในโปรเจ็กต์ (เราขอแนะนำให้จ่ายไม่เกิน $500 ต่ออาสาสมัคร 1 คน)
- การบริจาคดาวน์สตรีมไปยังโปรเจ็กต์โอเพนซอร์สอื่นๆ ควรมีมูลค่าไม่เกิน 10% ของงบประมาณทั้งหมด
- ระบุรายการงบประมาณอื่นๆ ตามที่จำเป็น พร้อมเหตุผลที่ของบประมาณ การชี้แจงค่าใช้จ่ายควรเน้นว่าค่าใช้จ่ายดังกล่าวจะส่งผลต่อความสำเร็จของโปรเจ็กต์โดยรวมอย่างไร
ตัวอย่างงบประมาณ
| รายการงบประมาณ | จำนวนเงิน | ยอดรวมสะสม | หมายเหตุ/เหตุผล |
|---|---|---|---|
| ผู้เขียนเนื้อหาทางเทคนิคตรวจสอบ อัปเดต ทดสอบ และเผยแพร่เอกสารประกอบใหม่เกี่ยวกับกระบวนการเพิ่มส่วนผสมสำหรับ GloriousPickle | 5000.00 | 5000.00 | |
| ค่าตอบแทนอาสาสมัคร | 500 | 6500.00 | ค่าตอบแทนอาสาสมัคร 3 คน x 500 บาทต่อคน |
| เสื้อยืดโปรเจ็กต์ (เสื้อยืด 10 ตัว) | 150.00 | 6650.00 | |
| ยูนิคอร์นเป่าลมขนาดยักษ์ (เวอร์ชัน 15 ฟุต) | 99.99 | 6749.99 | เราจะมอบยูนิคอร์นเป่าลมให้ทีมที่ตอบคำถามของผู้เขียนเนื้อหาทางเทคนิคได้เร็วที่สุดในช่วงการพัฒนาโปรเจ็กต์ |
| ทั้งหมด | 6749.99 |
ข้อมูลเพิ่มเติม
ใส่ข้อมูลเพิ่มเติมที่เกี่ยวข้องกับข้อเสนอของคุณที่นี่
ประสบการณ์ที่ผ่านมาเกี่ยวกับผู้เขียนเนื้อหาทางเทคนิคหรือเอกสารประกอบ: หากคุณหรือที่ปรึกษาเคยร่วมงานกับผู้เขียนเนื้อหาทางเทคนิคหรือเคยพัฒนาเอกสารประกอบ โปรดระบุข้อมูลนี้ในใบสมัคร อธิบายเอกสารประกอบที่คุณจัดทำขึ้นและวิธีที่คุณทำงานร่วมกับผู้เขียนเนื้อหาทางเทคนิค เช่น อธิบายกระบวนการตรวจสอบที่คุณใช้ หรือทักษะของผู้เขียนเนื้อหาทางเทคนิคที่เป็นประโยชน์ต่อโปรเจ็กต์ของคุณ อธิบายว่าประสบการณ์ที่ผ่านมานี้จะช่วยให้คุณทำงานร่วมกับผู้เขียนเนื้อหาทางเทคนิคใน Google Season of Docs ได้อย่างไร
การเข้าร่วม Google Season of Docs, Google Summer of Code หรือโปรแกรมอื่นๆ ก่อนหน้านี้: หากคุณหรือที่ปรึกษาของคุณเคยเข้าร่วม Google Summer of Code หรือโปรแกรมที่คล้ายกัน โปรดระบุข้อมูลนี้ในใบสมัคร อธิบายถึงความสำเร็จของคุณในโปรแกรมนั้น อธิบายว่าประสบการณ์นี้อาจส่งผลต่อวิธีทำงานของคุณใน Google Season of Docs อย่างไร