ระยะปัจจุบัน:
การพัฒนาเอกสาร ดูไทม์ไลน์
ต่อไปนี้คือหลักเกณฑ์ที่จะช่วยให้องค์กรโอเพนซอร์สทำงานอย่างชาญฉลาดในการเขียนข้อมูลเชิงเทคนิค
แนะนำนักเขียนด้านเทคนิคให้รู้จักโลกของโอเพนซอร์สและชุมชนของคุณ
- จัด "ทัวร์ชมพร้อมคำแนะนำ" สำหรับชุมชนของคุณให้กับนักเขียนด้านเทคนิค พวกเขาจะถามคำถามได้ที่ใด การประชุมปกติที่พวกเขาควรเข้าร่วม หรือรายชื่ออีเมลใด ที่พวกเขาควรเข้าร่วม ลูกค้าต้องใช้บัญชีใด (GitHub, Discord, Slack) ตรวจสอบว่าทีมเข้าใจหลักจรรยาบรรณของโปรเจ็กต์และรู้วิธีรายงานปัญหา ตรวจสอบว่านักเขียนด้านเทคนิคเข้าใจใบอนุญาตของโปรเจ็กต์ และปฏิบัติตามข้อกำหนดของนายจ้างรายอื่นๆ เกี่ยวกับการลงนามใน CLA, DCO หรือข้อตกลงอื่นๆ
- หากเป็นไปได้ แนะนำให้รู้จักกับสัก 2-3 คนในเขตเวลาที่ทับซ้อนกัน ซึ่งสามารถตอบคำถามเกี่ยวกับชุมชนหรือโครงการได้อย่างรวดเร็ว
- หากทำได้ โปรดส่งของที่ระลึกไปพร้อมๆ กัน
ช่วยนักเขียนด้านเทคนิคใช้เครื่องมือและกระบวนการที่เกี่ยวข้องกับการมีส่วนร่วมในโครงการของคุณ
- หากกระบวนการของคุณไม่มีการบันทึกไว้อย่างชัดเจน ให้นัดหมายเวลาสำหรับการแนะนำผู้เขียนด้านเทคนิคเกี่ยวกับการสนับสนุน ปัญหา หรือคำขอดึงข้อมูลครั้งแรก บริษัทควรใช้เทมเพลตหรือแท็กใด ใครบ้างที่ต้องตรวจสอบการสนับสนุนของตน และควรติดตามผลรีวิวอย่างไรและเมื่อใด หากงานมีตัวอย่างโค้ด จะทดสอบได้อย่างไร พวกเขาต้องรู้อะไรบ้างเกี่ยวกับกระบวนการ CI/CD หรือการเผยแพร่ของคุณ
ช่วยให้ผู้เขียนด้านเทคนิคเข้าใจโปรเจ็กต์และผู้ใช้ของโปรเจ็กต์
- อธิบายโปรเจ็กต์ของคุณอย่างละเอียดเพื่อให้ผู้เขียนด้านเทคนิคมีความเข้าใจในแนวคิดของผลิตภัณฑ์ที่ชัดเจน วิธีนี้จะช่วยให้นักเขียนเชิงเทคนิครู้สึกมั่นใจและน่าเชื่อถือมากขึ้นในการเขียนโปรเจ็กต์
- อธิบายความต้องการของผู้ที่จะใช้โครงการ พยายามให้ข้อมูลที่เจาะจงที่สุดเท่าที่จะทำได้ ไม่ใช่แค่ "นักพัฒนาซอฟต์แวร์" แต่เป็น "นักพัฒนาซอฟต์แวร์ที่สร้างเว็บไซต์" และ "นักพัฒนาซอฟต์แวร์ที่ใช้โปรแกรมหุ่นยนต์อุตสาหกรรม"
- ให้นักเขียนด้านเทคนิคติดต่อกับผู้เชี่ยวชาญเฉพาะด้านที่จำเป็น กล่าวคือ นักพัฒนาซอฟต์แวร์หรือผู้มีส่วนร่วมในโปรเจ็กต์คนอื่นๆ ที่รับผิดชอบด้านต่างๆ ของโปรเจ็กต์ที่ครอบคลุมในเอกสารประกอบ
- ตรวจสอบให้แน่ใจว่าผู้เขียนด้านเทคนิคมีเวลาและทรัพยากรที่จำเป็น จากผู้เชี่ยวชาญเฉพาะด้านและสมาชิกคนอื่นๆ ในชุมชน
ถามคำถาม
- ชุมชนหรือโปรเจ็กต์ของคุณอาจไม่เคยทำงานร่วมกับนักเขียนด้านเทคนิคหรือผู้ร่วมให้ข้อมูลเอกสารมาก่อน ใช้โอกาสนี้ในการเรียนรู้ และแชร์ความรู้ที่มี ขอความคิดเห็นเกี่ยวกับกระบวนการและเครื่องมือของคุณ นักเขียนด้านเทคนิคอาจมีคำแนะนำในการปรับปรุง