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

ระยะปัจจุบัน:
โปรแกรม Season of Docs ปี 2019 จบลงแล้วเมื่อวันที่ 6 มีนาคม 2020 ดูไทม์ไลน์

หลักเกณฑ์บางส่วนสำหรับองค์กรโอเพนซอร์สเกี่ยวกับวิธีทำงานร่วมกับนักเขียนด้านเทคนิคที่คุณเป็นที่ปรึกษาให้กับ Season of Docs มีดังนี้

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

สิ่งที่ควรคำนึงถึง

ที่ปรึกษาโอเพนซอร์สใน Season of Docs ไม่จำเป็นต้องเป็นนักเขียนด้านเทคนิคเสมอไป ที่ปรึกษาไม่จำเป็นต้องมีทักษะด้านเอกสารประกอบ และนักเขียนด้านเทคนิคนำทักษะเหล่านั้นมาใช้ในโปรเจ็กต์และในความสัมพันธ์

แต่ที่ปรึกษาจะนำความรู้เกี่ยวกับชุมชนโอเพนซอร์ส ผลิตภัณฑ์ รวมถึงกระบวนการและเครื่องมือที่โครงการโอเพนซอร์สใช้มาแทน

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