Page 36 - Suradeth
P. 36
28
3.1.5 ขั้นกำรเขียนเอกสำรประกอบ (Documentation)
กำรท ำเอกสำรประกอบโปรแกรม คือ กำรอธิบำยรำยละเอียดของโปรแกรมว่ำ จุดประสงค์ของโปรแกรมคืออะไร
สำมำรถท ำงำนอะไรได้บ้ำง และมีขั้นตอนกำรท ำงำนของโปรแกรมเป็นอย่ำงไร ฯลฯ เครื่องมือที่ช่วยในกำรออกแบบโปรแกรม
เช่น ผังงำน หรือ รหัสจ ำลอง ก็สำมำรถน ำมำประกอบกันเป็นเอกสำรประกอบโปรแกรมได้ ซึ่งเอกสำรประกอบโปรแกรม
โดยทั่วไปจะมีอยู่ ด้วยกัน 2 แบบคือ
3.1.5.1 เอกสารประกอบโปรแกรมส าหรับผู้ใช้ (User Documentation) จะเหมำะส ำหรับผู้ใช้ที่ไม่ต้อง
เกี่ยวข้องกับกำรพัฒนำโปรแกรม แต่เป็นผู้ที่ใช้งำนโปรแกรมอย่ำงเดียว จะเน้นกำรอธิบำยเกี่ยวกับกำรใช้งำนโปรแกรม เป็น
หลัก ตัวอย่ำงเช่น
1. โปรแกรมนี้ท ำอะไร ใช้งำนในด้ำนไหน
2. ข้อมูลเข้ำมีลักษณะอย่ำงไร
3. ข้อมูลออกหรือผลลัพธ์มีลักษณะอย่ำงไร
4. กำรเรียกใช้โปรแกรมท ำอย่ำงไร
5. ค ำสั่ง หรือข้อมูล ที่จ ำเป็นให้โปรแกรมเริ่มท ำงำน มีอะไรบ้ำง
6. อธิบำยเกี่ยวกับประสิทธิภำพ และควำมสำมำรถของโปรแกรม
3.1.5.2 เอกสารประกอบโปรแกรมส าหรับผู้เขียนโปรแกรม (Technical Documentation) จะเหมำะ
ส ำหรับผู้ใช้ที่ไม่ต้องเกี่ยวข้องกับกำรพัฒนำโปรแกรม แต่เป็นผู้ที่ใช้งำนโปรแกรมอย่ำงเดียว จะเน้นกำรอธิบำยเกี่ยวกับกำรใช้
งำนโปรแกรมเป็นหลัก ตัวอย่ำงเช่น
ส่วนที่เป็นค ำอธิบำยหรือหมำยเหตุในโปรแกรมหรือเรียกอีกอย่ำงหนึ่งว่ำ คอมเมนท์ (Comment) ซึ่งส่วน
ใหญ่มักจะเขียนแทรกอยู่ในโปรแกรม อธิบำยกำรท ำงำนของโปรแกรมเป็นส่วน ๆ
ส่วนอธิบำยด้ำนเทคนิค ซึ่งส่วนนี้มักจะท ำเป็นเอกสำรแยกต่ำงหำกจำก โปรแกรม จะอธิบำยในรำยละเอียด
ที่มำกขึ้น เช่น ชื่อโปรแกรมย่อยต่ำง ๆ อะไรบ้ำง แต่ละโปรแกรมย่อยท ำหน้ำที่อะไร และค ำอธิบำยย่อ ๆ เกี่ยวกับ วัตถุประสงค์
ของโปรแกรม เป็นต้น
