เอกสารคือกุญแจสำคัญ
แนวทางปฏิบัติที่ดีที่สุด 2 - กรอกเอกสารของคุณก่อนขั้นตอนถัดไป
ฉันเรียนจบปริญญาโทด้านคอมพิวเตอร์และแอปพลิเคชันแล้วและฉันก็กระตือรือร้นที่จะเขียนซอร์สโค้ดแม้ว่าจะไม่เข้าใจและจัดทำเอกสารข้อกำหนดทั้งหมด เอกสารการออกแบบและเอกสารกรณีทดสอบไม่มีที่ไหนเลยในวงจรชีวิตของการพัฒนาซอฟต์แวร์ .... มีการข้ามไปที่การเข้ารหัสโดยตรง
ในระยะต่อมาฉันพบว่าตัวเองมีปัญหาใหญ่และในไม่ช้าฉันก็รู้ Documentation is the Key เพื่อเป็นนักพัฒนาซอฟต์แวร์ผู้ทดสอบหรือสถาปนิกที่ประสบความสำเร็จ
ก่อนที่คุณจะเริ่มพัฒนาซอฟต์แวร์ขนาดเล็กหรือใหญ่คุณควรมีคำตอบสำหรับคำถามต่อไปนี้:
ข้อกำหนดข้อกำหนดอยู่ที่ไหน
เอกสารการวิเคราะห์ผลกระทบอยู่ที่ไหน
เอกสารการออกแบบอยู่ที่ไหน
คุณได้บันทึกข้อสันนิษฐานข้อ จำกัด ทั้งหมดอย่างถูกต้องหรือไม่?
คุณได้ตรวจสอบเอกสารทั้งหมดแล้วหรือยัง?
คุณได้รับการลงชื่อในเอกสารทั้งหมดจากผู้มีส่วนได้ส่วนเสียทั้งหมดหรือไม่?
เมื่อคุณมีคำตอบที่เป็นบวกสำหรับคำถามข้างต้นทั้งหมดคุณก็ปลอดภัยและพร้อมที่จะดำเนินการเขียนโค้ดต่อไป หลายองค์กรจะต้องปฏิบัติตามกฎระเบียบที่เข้มงวด แต่องค์กรอื่น ๆ จะไม่มี แนวทางปฏิบัติที่ดีที่สุดคือการกรอกเอกสารที่จำเป็นทั้งหมดและดำเนินการอนุมัติที่เหมาะสมก่อนดำเนินการต่อสำหรับการเข้ารหัสซอฟต์แวร์
สิ่งที่คุณเรียนรู้ในวันนี้เตรียมความพร้อมสำหรับวันพรุ่งนี้!
ดังนั้นอีกวิธีหนึ่งจึงเป็นแนวทางปฏิบัติที่ดีที่สุดที่จะต้องมีเอกสารประกอบให้มากที่สุด เอกสารสำคัญสองสามอย่างที่จะเตรียมคุณสำหรับอนาคต ได้แก่ :
- แนวทางการออกแบบ
- เคล็ดลับและคำแนะนำ
- ฟังก์ชั่นคำสั่งและคำสั่งพิเศษ
- บทเรียนที่ได้รับ
- สถานการณ์ที่แปลกประหลาด
- วิธีการดีบัก
- ปฏิบัติที่ดีที่สุด
- อะไรก็ได้ที่สามารถช่วยคุณได้ในอนาคต
การเก็บเอกสารด้วยระบบอิเล็กทรอนิกส์ไม่ทำให้คุณเสียค่าใช้จ่าย เริ่มต้นการบำรุงรักษาเอกสารที่จำเป็น