สารบัญ:
วีดีโอ: เอกสารซอร์สโค้ดคืออะไร?
2024 ผู้เขียน: Lynn Donovan | [email protected]. แก้ไขล่าสุด: 2023-12-15 23:54
ซอฟต์แวร์ เอกสาร เป็นข้อความหรือภาพประกอบที่มาพร้อมกับซอฟต์แวร์คอมพิวเตอร์หรือฝังอยู่ใน รหัสแหล่งที่มา . NS เอกสาร อธิบายว่าซอฟต์แวร์ทำงานอย่างไรหรือใช้งานอย่างไร และอาจมีความหมายแตกต่างกันไปสำหรับบุคคลในบทบาทที่แตกต่างกัน สถาปัตยกรรม/การออกแบบ – ภาพรวมของซอฟต์แวร์
เมื่อพิจารณาแล้ว คุณจะเขียนรหัสเอกสารอย่างไร
แนวปฏิบัติที่ดีที่สุดในการเขียนเอกสาร:
- รวมไฟล์ README ที่มี
- อนุญาตให้ใช้ตัวติดตามปัญหาสำหรับผู้อื่น
- เขียนเอกสาร API
- เอกสารรหัสของคุณ
- ใช้แบบแผนการเข้ารหัส เช่น การจัดระเบียบไฟล์ ความคิดเห็น หลักการตั้งชื่อ แนวทางปฏิบัติในการเขียนโปรแกรม ฯลฯ
- รวมข้อมูลสำหรับผู้ร่วมให้ข้อมูล
อาจมีคนถามว่าเอกสารสำหรับผู้ใช้คืออะไร? เอกสารผู้ใช้ หมายถึง เอกสาร สำหรับผลิตภัณฑ์หรือบริการที่มอบให้แก่ผู้ใช้ปลายทาง NS เอกสารผู้ใช้ ได้รับการออกแบบมาเพื่อช่วยผู้ใช้ปลายทางในการใช้ผลิตภัณฑ์หรือบริการ นี้มักจะเรียกว่า ผู้ใช้ ความช่วยเหลือ. NS เอกสารผู้ใช้ เป็นส่วนหนึ่งของผลิตภัณฑ์โดยรวมที่ส่งมอบให้กับลูกค้า
เมื่อพิจารณาแล้ว เอกสารประเภทใดบ้าง
ประเภท ของระบบ เอกสาร รวมข้อกำหนด เอกสาร , รหัสแหล่งที่มา เอกสาร , การประกันคุณภาพ เอกสาร , สถาปัตยกรรมซอฟต์แวร์ เอกสาร , คำแนะนำในการแก้ปัญหา และคู่มือช่วยเหลือสำหรับผู้ใช้ขั้นสูง ประเภท ของผู้ใช้ เอกสาร รวมถึงคู่มือการฝึกอบรม คู่มือผู้ใช้ บันทึกประจำรุ่น และคู่มือการติดตั้ง
สิ่งที่ควรรวมอยู่ในเอกสารซอฟต์แวร์?
สิ่งที่ต้องรวมไว้ในเอกสารของคุณ
- คำอธิบายว่าซอฟต์แวร์ของคุณทำอะไรและแก้ปัญหาอะไรได้บ้าง
- ตัวอย่างที่แสดงสถานการณ์ที่ปกติจะใช้รหัสของคุณ
- ลิงก์ไปยังโค้ดและตัวติดตามข้อบกพร่อง
- คำถามที่พบบ่อยและวิธีการขอรับการสนับสนุน
- คำแนะนำเกี่ยวกับวิธีการติดตั้งซอฟต์แวร์ของคุณ