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