Lecture 10 : Database Documentation 412 724 Database Management อ.จุฑาทิพย์ ไชยกำบัง อ.ศักดา จันทร์ประเสริฐ กลุ่มวิชาสารสนเทศและการสื่อสาร คณะมนุษยศาสตร์และสังคมศาสตร์ มหาวิทยาลัยขอนแก่น

Database Documentation ประเภทของเอกสารใช้งานระบบฐานข้อมูล (Type of Documentation) คู่มือทางเทคนิค (Technical Manual) คู่มือสำหรับผู้ใช้ (User’s Manual) องค์ประกอบของคู่มือสำหรับผู้ใช้ (User’s Manual) 412 724 Database Management

ประเภทของเอกสารใช้งานระบบฐานข้อมูล คู่มือทางเทคนิค (Technical Manual) สำหรับผู้ดูแลระบบ เพื่อใช้ในการติดตั้งระบบ หรือกรณีที่ระบบเกิดปัญหา ซึ่งผู้ดูแลระบบสามารถศึกษาและปฏิบัติตามขั้นตอนการแก้ไขในระดับเบื้องต้นได้ และอาจจำเป็นต้องมีคู่มือด้านเทคนิคประกอบด้วย 412 724 Database Management

ประเภทของเอกสารใช้งานระบบฐานข้อมูล คู่มือสำหรับผู้ใช้ (User’s Manual) อธิบายการทำงานและขั้นตอนต่างๆ ของระบบงานในแต่ละขั้นตอน เพื่อให้ผู้ใช้สามารถเรียนรู้และปฏิบัติเพื่อใช้งานระบบได้ 412 724 Database Management

องค์ประกอบของคู่มือสำหรับผู้ใช้ 1. แนะนำฐานข้อมูลและวัตถุประสงค์การจัดทำ (Database description and objectives) เป็นส่วนที่บอกให้ผู้ใช้สามารถตัดสินใจได้ว่า ฐานข้อมูลนี้มีข้อมูลที่เขาต้องการหรือไม่ จึงควรมีรายละเอียดเกี่ยวชื่อฐานข้อมูล ขอบเขตของฐานข้อมูล (ให้ข้อมูลเกี่ยวกับเรื่องใด) แหล่งที่มาของข้อมูล จำนวนเรคคอร์ด และวัตถุประสงค์ในการจัดทำ (เหมาะกับใคร เอาไปใช้ประโยชน์ได้อย่างไร) 412 724 Database Management

องค์ประกอบของคู่มือสำหรับผู้ใช้ 2. ฮาร์ดแวร์และซอฟต์แวร์ที่ใช้ (Hardware and software specifications) ระบุรายละเอียดเกี่ยวกับชนิด ขนาด และความสามารถ (ความเร็ว ความจุ ฯลฯ) อุปกรณ์อื่นๆ ที่ต้องมีเพื่อสามารถใช้ระบบฐานข้อมูลดังกล่าวได้ รวมทั้งซอฟต์แวร์ที่ต้องใช้งานกับระบบฐานข้อมูล 412 724 Database Management

องค์ประกอบของคู่มือสำหรับผู้ใช้ 3. ข้อกำหนดเกี่ยวกับการใช้ตัวอักษรในคู่มือ (Typology) ในกรณีที่มีการใช้ตัวอักษรในรูปแบบต่างๆ เพื่ออธิบายรายละเอียดในคู่มือให้ผู้ใช้เข้าใจง่ายขึ้น จำเป็นต้องชี้แจงไว้ในส่วนนี้ให้ชัดเจน เช่น ในคู่มือเล่มนี้ จะใช้ตัวอักษรเพื่ออธิบายรายละเอียดดังนี้ ตัวพิมพ์ใหญ่ (UPPER CASE) ใช้แทนชื่อเมนูหรือตัวเลือกในระบบ เช่น เลือกเมนู SEARCH เพื่อเริ่มการค้น เลือก REPORT1 เพื่อให้แสดงผลแบบตาราง เลือก PRINT เพื่อสั่งพิมพ์รายงานทางเครื่องพิมพ์ 412 724 Database Management

องค์ประกอบของคู่มือสำหรับผู้ใช้ ตัวพิมพ์หนา (Bold Type) ใช้แทนคีย์บอร์ด เช่น กด Alt-S เพื่อขอดูโครงสร้างของฐานข้อมูล กด F3 เพื่อขอดูรายการคำดรรชนี ตัวพิมพ์เอน (Italic) ใช้แทนข้อความที่ผู้ใช้ต้องพิมพ์ลงไปเพื่อตอบโต้กับระบบบนหน้าจอ ดังตัวอย่าง พิมพ์รหัสนักศึกษาที่ต้องการค้น เช่น 4186246 เพื่อค้นข้อมูลนักศึกษาตามรหัสประจำตัวของนักศึกษา 412 724 Database Management

องค์ประกอบของคู่มือสำหรับผู้ใช้ 4. เริ่มต้นใช้ฐานข้อมูล (How to Get Start) แนะนำผู้ใช้ให้สามารถเริ่มต้นใช้ฐานข้อมูลได้ เช่น จำเป็นหรือไม่ต้องคัดลอกไฟล์ลงในฮาร์ดดิสก์ หรือพิมพ์คำสั่ง/คลิกไอคอนใดเพื่อเปิดไฟล์ ฯลฯ เมื่อเปิดเข้าไปแล้วจะเห็นอะไรบนจอ ลักษณะสำคัญทั่วไปในระบบ (ที่เกี่ยวข้องกับผู้ใช้) มีอะไรบ้าง อะไรบ้างที่ผู้ใช้จำเป็นต้องรู้ เช่น เมนูหลัก เมนูสำหรับเปิดฐานข้อมูล ฯลฯ 412 724 Database Management

องค์ประกอบของคู่มือสำหรับผู้ใช้ 5. ฟิลด์และคำอธิบายฟิลด์ (Fields and field descriptions) แสดงรายชื่อฟิลด์ทุกฟิลด์ที่มีในฐานข้อมูล พร้อมทั้งคำอธิบายสั้นๆ ว่าฟิลด์นั้นให้ข้อมูลอะไร เช่น ชื่อฟิลด์ คำอธิบายฟิลด์ RECNO ลำดับที่ของเรคคอร์ด TITLE ชื่อเรื่องของซีดีรอม 412 724 Database Management

องค์ประกอบของคู่มือสำหรับผู้ใช้ 6. ตัวอย่างเรคคอร์ด (Example of record data) แสดงตัวอย่างของเรคคอร์ดที่มีอยู่ในฐาน เลือกเรคคอร์ดที่มีข้อมูลสมบูรณ์ที่สุด หากในฐานมีข้อมูลต่างๆ กัน เช่น เป็นรายการของบทความในวารสาร บทความในหนังสือ วิทยานิพนธ์ ต้องนำมาแสดงทุกๆ ตัวอย่าง 412 724 Database Management

องค์ประกอบของคู่มือสำหรับผู้ใช้ 7. วิธีการสืบค้นข้อมูล (Search Methodology) แนะนำวิธีการค้น มีกี่วิธี (Search methods) มีกี่ทางเลือก (Search Options) และเทคนิคการค้นมีอะไรบ้าง (Search Techniques) พร้อมทั้งตัวอย่างการค้นและผลที่ได้จากการค้นในแต่ละวิธีนั้น 412 724 Database Management

องค์ประกอบของคู่มือสำหรับผู้ใช้ 8. รูปแบบการแสดงผล (Search Results) อธิบายให้ทราบว่าในระบบฐานข้อมูลนี้สามารถเลือกแสดงผลได้กี่รูปแบบ (ตาม Report formats ที่ได้สร้างไว้) การแสดงผลแต่ละรูปแบบให้ข้อมูลอะไร ควรเลือกใช้เมื่อใด มีประโยชน์อย่างไร ควรมีตัวอย่างของผลลัพธ์แต่ละรูปแบบ 9. ภาคผนวก (Appendices) รวบรวมรายละเอียดอื่นๆ ที่คิดว่าผู้ใช้ควรทราบ เช่น รวมรายการคำสั่งในระบบ ตัวอย่างหน้าจอแบบต่างๆ ฟิลด์ที่ทำดรรชนีให้สามารถสืบค้นได้ ฯลฯ 412 724 Database Management