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