วิธีเขียนเอกสารการออกแบบที่ดี

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

---

คำจำกัดความ

• เอกสารการออกแบบคือ รายงานทางเทคนิค ที่สรุป กลยุทธ์การนำระบบไปใช้งานจริง ภายใต้บริบทของ trade-off และข้อจำกัด

เป้าหมาย

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

การจัดโครงสร้าง

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

การแก้ไขปรับปรุง

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

ประสบการณ์และการฝึกฝน

• ไม่มีทางลัดในการพัฒนาทักษะที่ดีไปกว่า การฝึกซ้ำ ๆ
• ประสบการณ์กับ วัฒนธรรมที่ให้เอกสารเป็นศูนย์กลาง ที่ Amazon ช่วยพัฒนาทักษะการเขียนเอกสารได้มาก
• ในการประชุมสำคัญ มีการแจกเอกสารการออกแบบขนาด 1–6 หน้า จากนั้นทุกคนจะ อ่านเงียบ ๆ และเขียนความเห็นลงในพื้นที่ว่าง
• การได้รับฟีดแบ็กช่วยพัฒนาทักษะการเขียนได้อย่างเป็นรูปธรรม

เคล็ดลับที่เป็นรูปธรรม

ใช้ย่อหน้าสั้น

• เอกสารการออกแบบควรสร้างการไหลของเนื้อหาด้วย bullet point ที่กระชับและต่อเนื่อง
• bullet point แต่ละข้อ (ข้อสังเกต แนวคิด ปัญหา การปรับปรุง ฯลฯ) ควรเป็น ย่อหน้าสั้น ที่โฟกัสกับ หนึ่งแนวคิด
• แต่ละย่อหน้าควรชัดเจนพอที่จะสรุปได้ด้วยหนึ่งประโยค ซึ่งจะช่วยประหยัด ทรัพยากรความจำระยะสั้น ของผู้อ่าน

ใช้ภาคผนวก

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

ตัวอย่างการแก้ไข

• (ก่อนแก้ไข, ย่อหน้าที่ยืดยาว):

  bullet point แต่ละข้อควรเป็นย่อหน้าแยกในเอกสาร แต่ละย่อหน้าควรสรุปได้ด้วยหนึ่งประโยค ไม่จำเป็นต้องเป็นหนึ่งประโยคจริง ๆ เพราะอาจต้องมีคำอธิบายเพิ่มเติมเพื่ออธิบายแนวคิด แต่หลังจากอ่านแล้ว ผู้อ่านควรสามารถสรุปเป็นหนึ่งประโยคได้

• (หลังแก้ไข, ย่อหน้าที่กระชับขึ้น):

  bullet point แต่ละข้อควรเป็นหนึ่งย่อหน้าและควรถูกสรุปได้ด้วยหนึ่งประโยค ไม่จำเป็นต้องมีเพียงหนึ่งประโยคจริง ๆ และหากจำเป็นก็สามารถเพิ่มคำอธิบายประกอบได้ แต่เมื่ออ่านจบแล้วควรถูกย่อเป็นหนึ่งประโยคได้

สรุปส่งท้าย

• เอกสารการออกแบบเป็น กระบวนการสำคัญ ที่ช่วยพัฒนาทักษะได้ผ่าน ความเคร่งครัดของการคิด การไหลเชิงตรรกะ การแก้ไขที่ยึดผู้อ่านเป็นศูนย์กลาง และการฝึกฝนซ้ำ ๆ