Volume 17 · Appendices
วัตถุประสงค์ของ Volume
Volume นี้รวบรวม reference material ที่ใช้ในทั้ง manual — เป็นจุดค้นหาเดียวสำหรับคำศัพท์ ตัวย่อ ไฟล์อ้างถึง และ cross-reference ระหว่าง volume
จุดประสงค์คือทำให้ reader ไม่ต้องเปิดหลาย volume เพื่อหาคำนิยามหรือที่อยู่ของไฟล์
โครงสร้าง Volume
ภาพรวม (A.0)
│
▼
Reference lookup (A.1-A.6)
│
├── Glossary — คำศัพท์ (A.1)
├── Acronyms — ตัวย่อ (A.2)
├── File index — ไฟล์สำคัญ (A.3)
├── Debt ID index — cross-reference ของ debt (A.4)
├── Volume cross-reference — matrix ระหว่าง volume (A.5)
└── Environment variables — consolidated env (A.6)
│
▼
Meta (A.7-A.9)
│
├── Bibliography — link ภายนอก (A.7)
├── Changelog + Errata (A.8)
└── Maintenance guide — วิธีอัปเดต manual (A.9)วิธีใช้ Appendices
กรณี 1 — เจอคำที่ไม่เข้าใจ
- ดู A.1 (Glossary) ก่อน
- ถ้าเป็นตัวย่อ ดู A.2 (Acronyms)
กรณี 2 — อ่าน volume แล้วเจอ file:line reference
- ดู A.3 (File index) เพื่อทำความเข้าใจว่าไฟล์นั้นทำหน้าที่อะไร
กรณี 3 — แก้ debt ตัวใดตัวหนึ่ง
- ดู A.4 (Debt ID index) เพื่อหา volume ทั้งหมดที่อ้างถึง debt ตัวนั้น
- แก้ debt ใน code
- อัปเดต volume ทุกเล่มที่อ้างถึง (ตามกฎใน A.8 Changelog)
กรณี 4 — ต้องการอัปเดต manual
- อ่าน A.9 (Maintenance guide) ก่อนเริ่ม
- ปฏิบัติตาม style rule และ correction protocol
ความสัมพันธ์กับ Volume อื่น
Appendices เป็นตัวช่วย (lookup) สำหรับ Volume 0-15 — ไม่ใช่เนื้อหาใหม่ ถ้าอ่าน volume อื่นแล้วเจอคำหรือไฟล์ที่ไม่เข้าใจ ให้กลับมาดูที่นี่
ข้อจำกัด
- ข้อมูล ณ วันที่รวบรวม — manual นี้เขียนจาก codebase สถานะ ณ กรกฎาคม 2026 ถ้า codebase เปลี่ยน ไฟล์ที่อ้างถึงอาจเลิกใช้หรือย้ายที่
- file:line อาจคลาดเคลื่อน — ถ้า code มีการแก้ไข line number จะเปลี่ยน ใช้เป็นจุดอ้างอิงเบื้องต้น ไม่ใช่ตำแหน่งที่แม่นยำ 100%
- Bibliography link อาจล้าสมัย — external doc เปลี่ยนตลอดเวลา ถ้า link ใช้ไม่ได้ ให้ค้นหา official doc ของ library นั้นโดยตรง
สรุปสาระสำคัญของแต่ละ appendix
| Appendix | เนื้อหา | เมื่อไหร่ใช้ |
|---|---|---|
| A.1 Glossary | คำศัพท์ทั้งหมด ~100 คำ | เจอคำที่ไม่เข้าใจ |
| A.2 Acronyms | ตัวย่อ ~80 ตัว | เจอตัวย่อที่ไม่รู้ |
| A.3 File index | ไฟล์สำคัญ ~60 ไฟล์ | เจอ file:line reference |
| A.4 Debt ID index | 58 debt IDs | แก้ debt หรืออ่านเกี่ยวกับ debt |
| A.5 Volume cross-reference | matrix 16×16 | หาเนื้อหาที่เกี่ยวข้องข้าม volume |
| A.6 Environment variables | consolidated env ของ 3 backend | ตั้งค่า env หรือ debug config |
| A.7 Bibliography | external doc links | อ่านเพิ่มเติมเกี่ยวกับ library/framework |
| A.8 Changelog + Errata | correction log + known issues | ตรวจสอบว่า manual ถูกแก้เมื่อไหร่ |
| A.9 Maintenance guide | วิธีอัปเดต manual | เป็น contributor ของ manual |