การทํางานกับนักเขียนด้านเทคนิค

ระยะปัจจุบัน:
การสรุปโปรเจ็กต์ ดูไทม์ไลน์

ต่อไปนี้เป็นแนวทางบางส่วนที่จะช่วยให้องค์กรโอเพนซอร์สทำงานร่วมกับผู้เขียนเนื้อหาทางเทคนิคได้อย่างมีประสิทธิภาพ

แนะนำนักเขียนเนื้อหาทางเทคนิคให้รู้จักโลกของโอเพนซอร์สและชุมชนของคุณ

  • แนะนำชุมชนของคุณให้นักเขียนเนื้อหาทางเทคนิคทราบ ผู้ใช้จะถามคําถามได้จากที่ใด การประชุมประจำที่ควรเข้าร่วม หรือรายชื่ออีเมลที่ควรสมัครเข้าร่วม ผู้ใช้ต้องมีบัญชีใดบ้าง (Github, Discord, Slack) ตรวจสอบว่าผู้ใช้เข้าใจหลักจรรยาบรรณของโปรเจ็กต์และทราบวิธีรายงานปัญหา ตรวจสอบว่าผู้เขียนเนื้อหาทางเทคนิคเข้าใจใบอนุญาตของโปรเจ็กต์และปฏิบัติตามข้อกำหนดของนายจ้างรายอื่นๆ เกี่ยวกับการลงนาม CLA, DCO หรือข้อตกลงอื่นๆ
  • หากเป็นไปได้ ให้แนะนำสมาชิกคนอื่นๆ ที่อยู่ในเขตเวลาเดียวกันซึ่งสามารถตอบคำถามเกี่ยวกับชุมชนหรือโปรเจ็กต์ได้อย่างรวดเร็ว
  • หากเป็นไปได้ ก็ส่งของที่ระลึกของโปรเจ็กต์ให้พวกเขา

ช่วยให้นักเขียนเนื้อหาทางเทคนิคใช้เครื่องมือและกระบวนการที่เกี่ยวข้องกับการมีส่วนร่วมในโปรเจ็กต์

  • หากกระบวนการของคุณไม่มีเอกสารประกอบที่ชัดเจน ให้นัดเวลาเพื่อแนะนำนักเขียนเทคนิคเกี่ยวกับการมีส่วนร่วม ปัญหา หรือคำขอดึงข้อมูลครั้งแรก ลูกค้าควรใช้เทมเพลตหรือแท็กใด ใครบ้างที่ต้องตรวจสอบผลงานของสมาชิก และสมาชิกควรติดตามผลการตรวจสอบอย่างไรและเมื่อใด หากผลงานมีตัวอย่างโค้ด เราจะทดสอบผลงานได้อย่างไร ทีมดังกล่าวจำเป็นต้องทราบอะไรบ้างเกี่ยวกับกระบวนการหรือรุ่น CI/CD

ช่วยให้ผู้เขียนเนื้อหาทางเทคนิคเข้าใจโปรเจ็กต์และผู้ใช้โปรเจ็กต์

  • อธิบายโปรเจ็กต์โดยละเอียดเพื่อให้ผู้เขียนเนื้อหาทางเทคนิคมีความเข้าใจที่ชัดเจนเกี่ยวกับแนวคิดของผลิตภัณฑ์ ซึ่งจะช่วยให้ผู้เขียนเนื้อหาทางเทคนิคมีความมั่นใจมากขึ้นและมีความน่าเชื่อถือมากขึ้นในการเขียนสำหรับโปรเจ็กต์
  • อธิบายความต้องการของผู้ใช้โปรเจ็กต์ ระบุให้เจาะจงที่สุดเท่าที่จะทำได้ ไม่ใช่แค่ "นักพัฒนาซอฟต์แวร์" แต่ให้ระบุเป็น "นักพัฒนาซอฟต์แวร์ที่สร้างเว็บไซต์" และ "นักพัฒนาซอฟต์แวร์เขียนโปรแกรมหุ่นยนต์อุตสาหกรรม"
  • ติดต่อนักเขียนเนื้อหาทางเทคนิคกับผู้เชี่ยวชาญเฉพาะด้านที่จำเป็น กล่าวคือ นักพัฒนาซอฟต์แวร์หรือผู้มีส่วนร่วมในโปรเจ็กต์คนอื่นๆ ที่รับผิดชอบด้านต่างๆ ของโปรเจ็กต์ซึ่งเอกสารประกอบจะครอบคลุม
  • ตรวจสอบว่านักเขียนเนื้อหาทางเทคนิคมีเวลาและทรัพยากรที่จำเป็นจากผู้เชี่ยวชาญด้านเนื้อหาและสมาชิกคนอื่นๆ ในชุมชน

ถามคำถาม

  • ชุมชนหรือโปรเจ็กต์ของคุณอาจไม่เคยร่วมงานกับผู้เขียนเนื้อหาทางเทคนิคหรือผู้มีส่วนร่วมในเอกสารประกอบมาก่อน ใช้ประโยชน์จากโอกาสในการเรียนรู้ขณะแชร์สิ่งที่คุณรู้ ขอความคิดเห็นเกี่ยวกับกระบวนการและเครื่องมือของคุณ นักเขียนเนื้อหาทางเทคนิคอาจมีคำแนะนำในการปรับปรุง