ระยะปัจจุบัน:
โปรแกรม Season of Docs ปี 2021 สิ้นสุดลงแล้วเมื่อวันที่ 14 ธันวาคม 2021 ดูไทม์ไลน์
หน้านี้มีเคล็ดลับสำหรับองค์กรโอเพนซอร์สเกี่ยวกับวิธีประเมินและเลือกผู้เขียนทางเทคนิคที่เหมาะสมสำหรับโปรเจ็กต์ Google Season of Docs
บทนำ
องค์กรโอเพนซอร์สต้องจ้างนักเขียนด้านเทคนิคให้ทำงานในโปรเจ็กต์ที่เสนอ องค์กรต้องหาผู้เขียนเนื้อหาทางเทคนิคของตนเอง นักเขียนเทคนิคที่สนใจร่วมงานกับองค์กรที่เข้าร่วม Google Season of Docs สามารถดูข้อมูลได้ใน Google Season of Docs GitHub repo และใน#season-of-docs channel ใน Slack ของ Write the Docs
การประเมินนักเขียนเชิงเทคนิค
เราขอแนะนำให้คุณขอตัวอย่างเอกสารประกอบที่พัฒนาก่อนหน้านี้จากนักเขียนเทคนิคที่คุณกำลังพิจารณา เพื่อให้คุณมุ่งเน้นที่การประเมินทักษะและประสบการณ์การเขียนเชิงเทคนิค
ทักษะและประสบการณ์ด้านการเขียนเชิงเทคนิค
ตรวจสอบประสบการณ์ที่ผ่านมาของผู้เขียนเนื้อหาทางเทคนิค นักเขียนเนื้อหาทางเทคนิคควรมีประสบการณ์ในการเขียนเอกสารทางเทคนิคสำหรับอุตสาหกรรมซอฟต์แวร์มาก่อน เป้าหมายอย่างหนึ่งของ Google Season of Docsคือการเปิดโอกาสให้ผู้เขียนเนื้อหาทางเทคนิคได้มีส่วนร่วมกับผลิตภัณฑ์ที่มุ่งเน้นนักพัฒนาซอฟต์แวร์ ด้วยเหตุนี้ นักเขียนจึงไม่จำเป็นต้องมีประสบการณ์เกี่ยวกับ API หรือ SDK หรือแพลตฟอร์มอื่นๆ สำหรับนักพัฒนาแอป แม้ว่าโปรเจ็กต์ของคุณจะมุ่งเน้นไปที่กลุ่มผู้ชมที่เป็นนักพัฒนาแอปก็ตาม
มุ่งเน้นทักษะด้านภาษาและการสื่อสาร ประเมินงานด้านเทคนิคที่ผ่านมาของผู้เขียนจากมุมมองนี้ สิ่งสำคัญที่สุดคือ คุณเข้าใจสิ่งที่คนคนนี้เขียนไหม หากต้องการตรวจสอบภาษาของงานเขียนทางเทคนิคอย่างละเอียด ให้มองหาความสอดคล้องของเครื่องหมายวรรคตอนและวลี การสะกดที่ถูกต้อง และภาษาที่ชัดเจน วลีเรียบง่ายหรือซับซ้อนไหม ประโยคสั้นหรือเล่นไปเรื่อยๆ จนยากที่จะตามทันหรือไม่
ให้ความสำคัญกับการออกแบบและเลย์เอาต์ของเอกสาร ตรวจสอบเลย์เอาต์โดยรวมของตัวอย่างเอกสาร การออกแบบมีความสมเหตุสมผลหรือไม่ คุณไปยังส่วนต่างๆ ของเอกสารหรือชุดเอกสารประกอบได้ง่ายๆ ไหม มีเนื้อหาที่ซ้ำกันหรือมีช่องว่างที่เห็นได้ชัดหรือไม่