ระยะปัจจุบัน:
การสรุปโปรเจ็กต์ ดูไทม์ไลน์
หน้านี้มีไว้สำหรับองค์กรโอเพนซอร์สที่อยู่ในระยะการสำรวจของกระบวนการสมัครเข้าร่วมโปรแกรมสำหรับองค์กร ตัวอย่างโปรเจ็กต์เหล่านี้เป็นเพียงตัวอย่างที่แสดงให้เห็นว่าองค์กรอาจอธิบายโปรเจ็กต์เอกสารประกอบที่เป็นไปได้ในหน้าไอเดียโปรเจ็กต์ขององค์กรอย่างไร องค์กรสามารถเสนอโปรเจ็กต์ที่ไม่ได้อยู่ในรายการนี้ได้
ไอเดียโปรเจ็กต์: สร้างคู่มือการเริ่มต้นใช้งานสำหรับผู้มีส่วนร่วม
ปัญหา
- ผู้มีส่วนร่วมใหม่ไม่พบข้อมูลการตั้งค่าที่จําเป็นต่อการมีส่วนร่วมที่มีความหมายในโปรเจ็กต์ของเรา กระบวนการบางอย่าง (เช่น การมีส่วนร่วมในการทดสอบ) ไม่ได้บันทึกไว้เลย
เราจะวัดความสำเร็จได้อย่างไร
- จำนวนผู้มีส่วนร่วมใหม่เพิ่มขึ้น
- เพิ่มจํานวนผู้มีส่วนร่วมใหม่ที่ไม่ได้เขียนโค้ด (โดยการทําให้มีส่วนร่วมในเอกสารหรือการทดสอบได้ง่ายขึ้น)
- จำนวนปัญหาที่เพิ่มขึ้นจากผู้มีส่วนร่วมใหม่ลดลง
- จำนวนปัญหาที่ปิดแล้วซึ่งติดแท็ก "ปัญหาแรกที่ดี" เพิ่มขึ้น
นักเขียนเนื้อหาทางเทคนิคต้องมีทักษะใดบ้างจึงจะทำงานในโปรเจ็กต์นี้ได้
- คุณสมบัติที่จำเป็น: ความคุ้นเคยกับ GitHub (หรือความเต็มใจที่จะทำตามบทแนะนำของ GitHub)
- คุณสมบัติเพิ่มเติม: ความคุ้นเคยกับโปรแกรมรันทดสอบของเรา เพื่อเรียกใช้การทดสอบและอัปเดตเอกสารประกอบสำหรับการดำเนินการดังกล่าว
อาสาสมัคร
กระตุ้นให้สมาชิกชุมชนลงชื่อสมัครใช้เพื่อช่วยเหลือในบางงาน เช่น
- @JaneQDev ช่วยตอบคําถามเกี่ยวกับทดสอบได้ไหม
- @ChenPCoder เรายินดีตรวจสอบคำขอดึงข้อมูลเอกสาร
- @ErichJEngineer ช่วยอธิบายขั้นตอนการมีส่วนร่วมในปัจจุบันกับนักเขียนเทคนิคได้ไหม
ข้อมูลติดต่อ
- นักเขียนเนื้อหาทางเทคนิคที่สนใจทำงานในโปรเจ็กต์นี้ควรส่งอีเมลไปที่ email@project ใส่ลิงก์ไปยังงานเขียนเชิงเทคนิคหรือพอร์ตโฟลิโอ/เรซูเม่/CV
แนวคิดโปรเจ็กต์: เขียนบทแนะนำเพื่อใช้คลังของเรากับ ...
ปัญหา
- โปรเจ็กต์ของเราได้รับปัญหามากมายจากผู้ใช้ที่พยายามใช้ไลบรารีของเรากับ $TechnologyX เราไม่มีคำแนะนำที่ชัดเจนสำหรับการผสานรวมกับ $TechnologyX และอาจเป็นเรื่องยาก
เราจะวัดความสำเร็จได้อย่างไร
- จำนวนปัญหาที่ติดแท็ก "$TechnologyX" ลดลง
- จำนวนคำขอดึงข้อมูลจากผู้มีส่วนร่วมรายใหม่ที่ช่วยให้เราแก้ไขข้อบกพร่องหรือเพิ่มเอกสารประกอบเกี่ยวกับ $TechnologyX เพิ่มขึ้น
- ลิงก์เพิ่มเติมไปยังโปรเจ็กต์ของเราจากโปรเจ็กต์ $TechnologyX
นักเขียนเนื้อหาทางเทคนิคต้องมีทักษะใดบ้างจึงจะทำงานในโปรเจ็กต์นี้ได้
- สิ่งที่แนะนำให้มี: ความคุ้นเคยกับ $TechnologyX
อาสาสมัคร
กระตุ้นให้สมาชิกชุมชนลงชื่อสมัครใช้เพื่อช่วยเหลืองานบางอย่าง เช่น
- @JaneQDev ช่วยตอบคำถามเกี่ยวกับ $TechnologyX ได้ไหม
- @ChenPCoder เรายินดีตรวจสอบคำขอดึงข้อมูลเอกสาร
ข้อมูลติดต่อ
- นักเขียนเนื้อหาทางเทคนิคที่สนใจทำงานในโปรเจ็กต์นี้ควรส่งอีเมลไปที่ email@project ใส่ลิงก์ไปยังงานเขียนเชิงเทคนิคหรือพอร์ตโฟลิโอ/เรซูเม่/CV
แนวคิดโปรเจ็กต์: จัดระเบียบเอกสารประกอบใหม่
ปัญหา
- เอกสารประกอบของเรามีเนื้อหามากมายและไม่เป็นระเบียบ ผู้ใช้จํานวนมากเลิกพยายามค้นหาคําตอบในเอกสารประกอบและเพียงแค่แจ้งปัญหาหรือถามคําถามในฟอรัมแทน หน้าเว็บของเราไม่ปรากฏในผลการค้นหาแม้ว่าจะใช้คีย์เวิร์ดที่เกี่ยวข้องก็ตาม
เราจะวัดความสำเร็จได้อย่างไร
- SEO ที่ดีขึ้นสําหรับเอกสารประกอบ
- จำนวนปัญหาที่เพิ่มขึ้นสำหรับหัวข้อที่ครอบคลุมในเอกสารประกอบลดลง
- จำนวนการมีส่วนร่วมในเอกสารประกอบเพิ่มขึ้น
นักเขียนเนื้อหาทางเทคนิคต้องมีทักษะใดบ้างจึงจะทำงานในโปรเจ็กต์นี้ได้
- คุณสมบัติเพิ่มเติม: มีประสบการณ์ในการจัดทำเอกสารประกอบขนาดใหญ่และชุดเอกสารประกอบที่สมบูรณ์แล้ว ทำความเข้าใจ SEO
อาสาสมัคร
กระตุ้นให้สมาชิกชุมชนลงชื่อสมัครใช้เพื่อช่วยเหลืองานบางอย่าง เช่น
- @ChenPCoder เรายินดีตรวจสอบคำขอดึงข้อมูลเอกสาร
ข้อมูลติดต่อ
- นักเขียนเนื้อหาทางเทคนิคที่สนใจทำงานในโปรเจ็กต์นี้ควรส่งอีเมลไปที่ email@project ใส่ลิงก์ไปยังงานเขียนเชิงเทคนิคหรือพอร์ตโฟลิโอ/เรซูเม่/CV
Project Idea: run a documentation fixit
ปัญหา
- เรามีข้อบกพร่องเล็กๆ น้อยๆ และปัญหาเก่าๆ มากมายที่เกี่ยวข้องกับเอกสารประกอบ ชุมชนของเรายินดีที่จะช่วยเหลือและช่วยแก้ไข แต่เราต้องการคนจัดระเบียบและดำเนินการแก้ไขจริง
เราจะวัดความสำเร็จได้อย่างไร
- จำนวนปัญหาเกี่ยวกับเอกสารประกอบที่ปิดแล้ว
- จำนวนผู้มีส่วนร่วมในเอกสารประกอบและผู้มีส่วนร่วมใหม่เพิ่มขึ้น
นักเขียนเนื้อหาทางเทคนิคต้องมีทักษะใดบ้างจึงจะทำงานในโปรเจ็กต์นี้ได้
- คุณสมบัติเพิ่มเติม: มีประสบการณ์ในการเรียกใช้เครื่องมือแก้ไขเอกสารประกอบ
- ทักษะการจัดระเบียบที่ดี
อาสาสมัคร
กระตุ้นให้สมาชิกชุมชนลงชื่อสมัครใช้เพื่อช่วยเหลืองานบางอย่าง เช่น
- @ChenPCoder ช่วยจัดระเบียบวิดีโอและแชทสำหรับฟีเจอร์การแก้ไขและช่วยค้นหาอาสาสมัครในเขตเวลาอื่นๆ ได้ไหม
ข้อมูลติดต่อ
- นักเขียนเนื้อหาทางเทคนิคที่สนใจทำงานในโปรเจ็กต์นี้ควรส่งอีเมลไปที่ email@project/เปิดปัญหาหรือถามในฟอรัมของเรา ใส่ลิงก์ไปยังงานเขียนเชิงเทคนิคหรือพอร์ตโฟลิโอ/เรซูเม่/CV
แนวคิดโปรเจ็กต์: ตรวจสอบเอกสารประกอบ
ปัญหา
- เราไม่ทราบสถานะของเอกสารประกอบ เราจัดลำดับความสำคัญของการปรับปรุงเอกสารประกอบได้ยากเนื่องจากไม่มีแผนงานหรือทราบปัญหาที่เร่งด่วนที่สุด นอกจากนี้ เรายังมีเนื้อหาที่ล้าสมัยจำนวนมากที่ควรลบหรือเก็บถาวร
เราจะวัดความสำเร็จได้อย่างไร
- การสร้างแผนงานเอกสารประกอบโดยได้รับอนุมัติทั่วไปจากชุมชน
- จำนวนหน้าเอกสารประกอบที่ล้าสมัยหรือไม่ถูกต้องลดลง
นักเขียนเนื้อหาทางเทคนิคต้องมีทักษะใดบ้างจึงจะทำงานในโปรเจ็กต์นี้ได้
- สิ่งที่แนะนำให้มี: ประสบการณ์ในการตรวจสอบเอกสาร
อาสาสมัคร
กระตุ้นให้สมาชิกชุมชนลงชื่อสมัครใช้เพื่อช่วยเหลือในบางงาน เช่น
- @JaneQCoder ช่วยประสานงานการนำเสนอแผนงานเอกสารประกอบในการประชุมชุมชนได้ไหม
ข้อมูลติดต่อ
- นักเขียนเนื้อหาทางเทคนิคที่สนใจทำงานในโปรเจ็กต์นี้ควรส่งอีเมลไปที่ email@project/เปิดปัญหาหรือถามในฟอรัมของเรา ใส่ลิงก์ไปยังงานเขียนเชิงเทคนิคหรือพอร์ตโฟลิโอ/เรซูเม่/CV
ข้อมูลที่เกี่ยวข้อง
- หน้าการโปรโมตและสื่อมีโลโก้และเนื้อหาอื่นๆ ที่คุณสามารถใช้เมื่อพูดถึง Google Season of Docs
- วิดีโอนี้จาก PyCon Australia 2017 มีคำแนะนำเกี่ยวกับการจัดระเบียบเอกสารประกอบเพื่อให้ผู้ใช้เห็นว่ามีประโยชน์ วิดีโอชื่อ What nobody tells you about Documentation โดย Daniele Procida