Page 105 - เอกสารประกอบการสอนพื้นฐานการเขียนโปรแกรมคอมพิวเตอร์

104

เอกสารประกอบโปรแกรมโดยทั่วไปแบ่งออกเป็น 2 ประเภท ได้แก่
4.1 คู่มือส าหรับผู้ใช้โปรแกรม (User’s Manual or User’s Guide) จะเน้นการ

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

- ข้อมูลน าเข้ามีลักษณะอย่างไร
- ผลลัพธ์ที่ได้จากโปรแกรมเป็นข้อมูลลักษณะอย่างไร
- วิธีการเรียกใช้โปรแกรมสามารถท าได้อย่างไร
4.2 คู่มือส าหรับผู้เขียนโปรแกรม (Programmer’s Manual or Programmer’s

Guide) จะจัดท าขึ้นเพื่อบุคคลเป็นการเฉพาะและอาจไม่เผยแพร่ทั่วไป อธิบายการท างานของ
โปรแกรมเป็นส่วน ๆ ท าให้ผู้เขียนโปรแกรมหรือช่างเทคนิคสามารถศึกษาและเข้าใจโปรแกรม
เอกสารประกอบโปรแกรมส าหรับผู้เขียนโปรแกรม จะได้ออกได้เป็น 2 ส่วน

- ส่วนที่เป็นค าอธิบายในโปรแกรมหรือหมายเหตุในโปรแกรม หรือเรียกอีกอย่าง
หนึ่งว่าคอมเมนท์ (Comment) ซึ่งส่วนใหญ่มักจะเขียนแทรกอยู่ในโปรแกรม อธิบายการท างานของ
โปรแกรมเป็นส่วน ๆ
- ส่วนอธิบายด้านเทคนิค จะท าเป็นเอกสารแยกต่างหากจากโปรแกรมจะอธิบาย
ในรายละเอียดที่มากขึ้น เช่น ชื่อโปรแกรมย่อยต่าง ๆ มีอะไรบ้าง แต่ละโปรแกรมย่อยท าหน้าที่อะไร

และค าอธิบายย่อ ๆ เกี่ยวกับวัตถุประสงค์ของโปรแกรม

ส าหรับผู้ที่เริ่มศึกษาพื้นฐานการเขียนโปรแกรมคอมพิวเตอร์นั้นควรฝึกท าเอกสารประกอบ

โปรแกรมอย่างง่าย โดยอาจจะประกอบด้วยส่วนต่าง ๆ ดังนี้
1. แนวคิดเกี่ยวกับการออกแบบโปรแกรม
- การวิเคราะห์ปัญหา
- การออกแบบโปรแกรม

2. รายละเอียดโปรแกรม
- ตัวโปรแกรม (Source Code)
- อธิบายหน้าจอแสดงการป้อนข้อมูลและแสดงผลลัพธ์
3. คุณลักษณะของเครื่องคอมพิวเตอร์และโปรแกรมที่ใช้

- ฮาร์ดแวร์ (Hardware) และ ซอฟต์แวร์ (Software) ที่ใช้ในการพัฒนาโปรแกรม