ศิลปะของ Technical Writing: เอกสารที่นักพัฒนาอ่านจริง

ศิลปะของการเขียนเชิงเทคนิค: เอกสารที่นักพัฒนาอ่านจริง

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

ตัวอย่างโค้ดและ Living Documentation

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