เอกสารโปรแกรม

ข้อความที่เป็นลายลักษณ์อักษรภาพประกอบหรือวิดีโอใด ๆ ที่อธิบายซอฟต์แวร์หรือโปรแกรมแก่ผู้ใช้จะเรียกว่า program or software document. ผู้ใช้สามารถเป็นใครก็ได้ตั้งแต่โปรแกรมเมอร์นักวิเคราะห์ระบบและผู้ดูแลระบบจนถึงผู้ใช้ปลายทาง ในขั้นตอนต่างๆของการพัฒนาอาจมีการสร้างเอกสารหลายชุดสำหรับผู้ใช้ที่แตกต่างกัน ในความเป็นจริง,software documentation เป็นกระบวนการที่สำคัญในกระบวนการพัฒนาซอฟต์แวร์โดยรวม

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

นี่คือแนวทางบางประการในการสร้างเอกสาร -

• เอกสารควรมาจากมุมมองของผู้อ่าน

• เอกสารควรไม่คลุมเครือ

• ไม่ควรมีการทำซ้ำ

• ควรใช้มาตรฐานอุตสาหกรรม

• เอกสารควรได้รับการอัปเดตอยู่เสมอ

• เอกสารใด ๆ ที่ล้าสมัยควรถูกยกเลิกหลังจากครบกำหนดบันทึกเฟสเอาต์

ข้อดีของเอกสาร

นี่คือข้อดีบางประการของการจัดเตรียมเอกสารโปรแกรม -

• ติดตามทุกส่วนของซอฟต์แวร์หรือโปรแกรม

• การดูแลรักษาทำได้ง่ายกว่า

• โปรแกรมเมอร์นอกเหนือจากผู้พัฒนาสามารถเข้าใจทุกแง่มุมของซอฟต์แวร์ได้

• ปรับปรุงคุณภาพโดยรวมของซอฟต์แวร์

• ช่วยในการฝึกอบรมผู้ใช้

• ช่วยให้มั่นใจได้ว่าการรวมศูนย์ความรู้ลดต้นทุนและความพยายามหากผู้คนออกจากระบบอย่างกะทันหัน

ตัวอย่างเอกสาร

ซอฟต์แวร์สามารถมีเอกสารหลายประเภทที่เกี่ยวข้อง บางส่วนที่สำคัญ ได้แก่ -

• User manual - อธิบายถึงคำแนะนำและขั้นตอนสำหรับผู้ใช้ปลายทางในการใช้คุณสมบัติต่างๆของซอฟต์แวร์

• Operational manual - แสดงรายการและอธิบายการดำเนินการทั้งหมดที่ดำเนินการและการพึ่งพาระหว่างกัน

• Design Document- ให้ภาพรวมของซอฟต์แวร์และอธิบายองค์ประกอบการออกแบบโดยละเอียด เอกสารรายละเอียดเช่นdata flow diagrams, entity relationship diagramsฯลฯ

• Requirements Document- มีรายการข้อกำหนดทั้งหมดของระบบตลอดจนการวิเคราะห์ความเป็นไปได้ของข้อกำหนด อาจมีกรณีผู้ใช้สถานการณ์เหมือนจริง ฯลฯ

• Technical Documentation - เป็นเอกสารประกอบของส่วนประกอบการเขียนโปรแกรมจริงเช่นอัลกอริทึมผังงานรหัสโปรแกรมโมดูลการทำงานเป็นต้น

• Testing Document - บันทึกแผนการทดสอบกรณีทดสอบแผนการตรวจสอบแผนการตรวจสอบผลการทดสอบ ฯลฯ การทดสอบเป็นขั้นตอนหนึ่งของการพัฒนาซอฟต์แวร์ที่ต้องใช้เอกสารที่เข้มข้น

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