1 Documentation SCC : Suthida Chaichomchuen

2 Documentation การจัดทำเอกสารต่าง ๆ ที่เกิดขึ้นในการ พัฒนาระบบงาน จากขั้นตอนต่าง ๆ อาทิ –ขั้นตอนการวิเคราะห์ –ขั้นตอนการออกแบบ –รวมทั้งเอกสารที่แสดงรายละเอียดขั้นตอน การทำงาน

3 จุดมุ่งหมายของการจัดทำเอกสาร เพื่อเป็นสื่อการติดต่อสื่อสารระหว่างสมาชิก ภายในทีมงานพัฒนาทั้งหมด เพื่อใช้เป็นแหล่งข้อมูลสำหรับผู้ที่มีหน้าที่ บำรุงดูแลรักษาระบบ เพื่อช่วยให้ทีมงานบริหารระบบสามารถ วางแผน กำหนดงบประมาณ และตารางการ ปฏิบัติงานของกระบวนการผลิตและการ พัฒนาระบบนั้น ๆ

4 จุดมุ่งหมาย... เพื่อแจ้งให้ผู้ใช้ระบบทราบว่าจะใช้และ บริหารระบบนั้น ๆ อย่างไร

5 ประเภทของเอกสารคู่มือระบบงาน แบ่งได้เป็น 2 ประเภทคือ Process Documentation –เอกสารด้านกระบวนการสร้างระบบ Product Documentation –เอกสารด้านผลผลิตของระบบ

6 Process Documentation เป็นเอกสารที่อธิบายกระบวนการพัฒนาและ บำรุงรักษาระบบ ตั้งแต่แผนงาน กำหนดการ ไปจนถึงเกณฑ์และมาตรฐานของระบบ

7 Process Documentation ประเด็นต่าง ๆ ในเอกสารมีดังนี้ แผนการดำเนินการ รายงาน เกณฑ์มาตรฐาน เอกสารการทำงาน บันทึกหมายเหตุต่าง ๆ

8 แผนการดำเนินการ แผนการดำเนินการ การประเมินค่าใช้จ่าย และการกำหนดกระบวนการทำงานและการ กำหนดระยะเวลาต่าง ๆ เป็นเอกสารสำหรับผู้จัดการระบบที่จะใช้ ควบคุมกระบวนการผลิต

9 รายงาน เป็นเอกสารบันทึกผลการทำงานในแต่ละ ขั้นตอน พร้อมทั้งบันทึกทรัพยากรที่เสียไปในขณะ พัฒนาระบบ

10 เกณฑ์มาตรฐาน เป็นเอกสารระบุวิธีที่จะใช้ใน กระบวนการพัฒนาระบบงานมาตรฐานที่ใช้ อาจจะเป็นข้อกำหนดขององค์การเอง หรืออาจจะเป็นข้อกำหนดในระดับชาติหรือ นานาชาติก็ได้

11 เอกสารการทำงาน เป็นบันทึกการทำงานด้านเทคนิค แนวความคิดของวิศวกรผู้ที่มีหน้าผลิตระบบ อาจเป็นการบันทึกกลวิธีการแก้ปัญหา และ การตัดสินใจดำเนินการต่าง ๆที่เกิดขึ้น ในขณะพัฒนาระบบ

12 บันทึกหมายเหตุต่าง ๆ เป็นเอกสารบันทึกการติดต่อสื่อสารระหว่าง บุคคลต่าง ๆ ที่ทำงานอยู่ร่วมทีมเดียวกัน

13 Product Documentation เป็นเอกสารที่อธิบายตัวระบบงานที่ถูก พัฒนาขึ้นมา และส่งต่อให้กับผู้ใช้ต่าง ๆ จำแนกได้เป็น 2 ประเภทคือ System Documentation –เอกสารเกี่ยวกับระบบงาน User Documentation –เอกสารสำหรับผู้ใช้ระบบ

14 System Documentation คือ เอกสารที่แสดงขั้นตอนการทำงานภายใน ของระบบ และรายละเอียดเฉพาะของการ ออกแบบระบบ เช่น –แบบจำลองต่าง ๆ –พจนานุกรมข้อมูล –แบบร่างสำหรับการออกแบบ

15 System Documentation จำแนกได้เป็น 2 กลุ่มคือ Internal Documentation –เอกสารภายใน คือ เอกสารที่แสดงโค้ด ของโปรแกรมที่เขียนขึ้น External Documentation –เอกสารภายนอก คือ เอกสารที่เป็น แผนภาพและแบบจำลองชนิดต่าง ๆ ของ ระบบ

16 User Documentation คือ เอกสารที่จัดทำขึ้นเพื่อแสดงขั้นตอนการ ใช้งานระบบ และวิธีใช้งานโปรแกรม แบ่งได้เป็น 5 ประเภทคือ –เอกสารองค์ประกอบของงาน –คู่มือการใช้งานเบื้องต้น –คู่มืออ้างอิงระบบงาน –เอกสารการติดตั้งระบบ –คู่มือสำหรับนักบริหารระบบ

17 เอกสารองค์ประกอบของงาน Functional Description อธิบายขอบข่ายและข้อจำกัดในการทำงาน ของระบบ ช่วยให้มองเห็นภาพรวมของระบบทั้งหมด

18 คู่มือการใช้งานเบื้องต้น Introductory Manual เป็นการแนะนำระบบงาน อธิบายการใช้งาน โดยทั่วไป จะเริ่มต้นใช้ระบบอย่างไร และจะ ใช้ทำงานอะไรบ้าง

19 คู่มืออ้างอิงระบบงาน Reference Manual อธิบายโครงสร้างและการใช้งานของระบบ ควรจะมีรายการข้อผิดพลาดที่อาจเกิดขึ้นได้ ทั้งหมด พร้อมทั้งวิธีการแก้ไขข้อผิดพลาด ต่าง ๆ เอกสารนี้จะต้องมีความสมบูรณ์มากที่สุด

20 เอกสารการติดตั้งระบบ Installation Document เป็นเอกสารสำหรับผู้บริหารระบบ ครอบคลุมวิธีการติดตั้งระบบใน สภาพแวดล้อมที่แตกต่างกันออกไป

21 คู่มือสำหรับบักบริหารระบบ System Administrator Guide เป็นเอกสารอธิบายการทำงานของระบบ ที่ อาจมีส่วนสัมพันธ์กับระบบงานอื่น ๆ ใน องค์การ ครอบคลุมวิธีการำงานของผู้ควบคุมระบบ วิธีการแก้ไขปัญหาข้อผิดพลาดที่อาจเกิดขึ้น จากการใช้งานระบบภายในองค์การ

22 กระบวนการผลิตเอกสาร แบ่งออกได้เป็น 4 ขั้นตอนคือ การลงมือเขียนเอกสาร การขัดเกลาเอกสาร การผลิตเอกสาร การประเมินผลการใช้งาน

23 กระบวนการผลิตเอกสาร

24 แนวทางการเขียนเอกสาร การนำเสนอควรจะเริ่มต้นจากสิ่งที่ผู้ใช้รู้เป็น พื้นเดิม โดยเริ่มจากงานที่ผู้ใช้คุ้นเคย การลัดลำดับเนื้อหาควรดำเนินรอยตาม กระบวนการเรียนรู้ของผู้ใช้ ใช้วิธีการเขียนที่เรียบง่าย มีตัวอย่างชัดเจน มีส่วนสรุป และผังการดำเนินการอย่างเป็น ขั้นตอน

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