การสร้างข้อตกลงสําหรับนักเขียนด้านเทคนิค

ระยะปัจจุบัน:
การพัฒนาเอกสาร ดูไทม์ไลน์

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

ขอบเขตงาน

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

ค่าตอบแทน

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

การสื่อสาร

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

เครื่องมือ

  • นักเขียนด้านเทคนิคต้องใช้เครื่องมือใด (หรือเครื่องมือในเวอร์ชันต่างๆ) เพื่อสร้างผลงาน
  • ใครเป็นผู้รับผิดชอบในการช่วยผู้เขียนด้านเทคนิคตั้งค่า รับสิทธิ์เข้าถึง หรือ ขออนุญาต

การแก้ปัญหาความเห็นไม่ตรงกัน

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