𝗗𝗼𝗰𝘂𝗺𝗲𝗻𝘁𝗮𝘁𝗶𝗼𝗻 𝗜𝘀 𝗔 𝗙𝗲𝗮𝘁𝘂𝗿𝗲

Documentation ไม่ใช่สิ่งที่แยกออกจากผลิตภัณฑ์ของคุณ แต่มันคือส่วนหนึ่งของผลิตภัณฑ์

นักพัฒนาหลายคนทำตามรูปแบบที่ผิดพลาด:

  • สร้างฟีเจอร์
  • ทดสอบฟีเจอร์
  • ส่งมอบฟีเจอร์
  • ทำเอกสารประกอบฟีเจอร์

ผู้ใช้ไม่ได้สัมผัสกับโค้ดของคุณ แต่พวกเขาใช้ interface, workflow และ documentation ของคุณ สำหรับผู้ใช้แล้ว Documentation คือฟีเจอร์หนึ่ง

ผู้สร้างมักละเลยการทำ documentation เพราะพวกเขาเข้าใจผลิตภัณฑ์ดีอยู่แล้ว คุณรู้ว่าทำไมคุณถึงตัดสินใจแบบนั้น คุณรู้ว่า API ทำงานอย่างไร และคุณรู้ทางลัดต่างๆ

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

ให้มองว่าคำถามที่ถูกถามซ้ำๆ คือ "หนี้ของ documentation" (documentation debt) หากมีคนถามคำถามเดิมซ้ำเป็นครั้งที่สอง แสดงว่าคุณมีปัญหาแล้ว ไม่ว่าจะเป็นเพราะผลิตภัณฑ์ของคุณน่าสับสน หรือ documentation ของคุณยังไม่สมบูรณ์ บางครั้งคุณอาจต้องแก้ไขที่ API แต่บ่อยครั้ง คุณแค่ต้องแก้ไขที่ documentation

Documentation ที่ดีจะช่วยลดอุปสรรค (friction) และตอบคำถามเหล่านี้ได้อย่างรวดเร็ว:

  • นี่คืออะไร?
  • ทำไมฉันถึงควรใช้มัน?
  • ฉันจะเริ่มต้นได้อย่างไร?
  • วิธีการที่ดีที่สุดคืออะไร?
  • ขอยกตัวอย่างง่ายๆ หน่อยได้ไหม?

เป้าหมายไม่ใช่ความสมบูรณ์แบบ แต่คือการสร้างแรงขับเคลื่อน (momentum)

Documentation ที่ยอดเยี่ยมจะสอนเรื่องรูปแบบ (patterns) และเจตนา (intent) มันจะอธิบายว่าทำไม framework ถึงทำงานในลักษณะนั้นๆ ซึ่งจะช่วยให้ผู้ใช้ทำงานได้อย่างมีประสิทธิภาพมากขึ้น

Documentation ส่งผลต่อธุรกิจของคุณในแบบที่เงียบเชียบ:

  • อัตราการนำไปใช้งาน (Adoption rates)
  • ความเร็วในการเริ่มต้นใช้งาน (Onboarding speed)
  • ค่าใช้จ่ายในการสนับสนุน (Support costs)
  • การเติบโตของชุมชน (Community growth)
  • ประสบการณ์ของนักพัฒนา (Developer experience)

คุณอาจมองไม่เห็นผลกระทบของ documentation ที่ดีได้โดยง่าย แต่คุณจะสังเกตเห็นผลกระทบจากการขาด documentation ที่ดีได้ในทันที

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

คุณภาพของผลิตภัณฑ์และคุณภาพของ documentation นั้นเชื่อมโยงกัน:

  • ซอฟต์แวร์ที่น่าสับสนต้องการ documentation มากขึ้น
  • ซอฟต์แวร์ที่ชัดเจนต้องการน้อยลง
  • Documentation ที่ดีจะเผยให้เห็นถึงการออกแบบที่แย่

เลิกมองว่า documentation เป็นเรื่องที่ค่อยทำทีหลังได้ ให้ใช้มันเป็นเครื่องมือในการบังคับให้เกิดความชัดเจน ความชัดเจนจะช่วยปรับปรุงการออกแบบของคุณ และการออกแบบที่ดีขึ้นจะช่วยพัฒนาผลิตภัณฑ์ของคุณ

ที่มา: https://dev.to/stinklewinks/documentation-is-a-feature-228n