Skip to content

01.05 โครงสร้างเอกสาร (Documentation Structure) ​


📌 At a Glance ​

รายการรายละเอียด
TopicDocumentation Structure
Difficulty⭐ Beginner
Reading Time6 นาที
Related ModuleAll Documentation
Targetทุกกลุ่มผู้ใช้งาน

⏱ Reading Time ​

ประมาณ 6 นาที


🎯 Learning Objectives ​

หลังจากศึกษาหัวข้อนี้แล้ว ผู้อ่านจะสามารถ

  • เข้าใจโครงสร้างของเอกสารทั้งชุด
  • เลือกอ่านเฉพาะบทที่เกี่ยวข้องกับงานของตนเอง
  • เข้าใจลำดับการศึกษาเอกสาร

Overview ​

SISAHYGO Documentation ถูกออกแบบให้เป็น Project Documentation มากกว่าคู่มือ API ทั่วไป โดยแบ่งเนื้อหาออกเป็นบท (Chapter) และ Section อย่างชัดเจน

ทุกบทสามารถอ่านแยกกันได้ (Self-contained Chapter) แต่หากศึกษาเรียงลำดับ จะช่วยให้เข้าใจระบบได้รวดเร็วและครบถ้วนมากขึ้น


Business Value ​

การจัดโครงสร้างเอกสารอย่างเป็นระบบช่วยให้

  • ลดเวลาค้นหาข้อมูล
  • ลดความสับสนระหว่างทีม Business และ Technical
  • รองรับการขยาย API ในอนาคต
  • ใช้เป็นมาตรฐานเดียวกันทั้งองค์กร

Technical Overview ​

Documentation Project แบ่งออกเป็น 13 บทหลัก

Chapterเนื้อหา
1Introduction
2System Overview
3API Standards
4Authentication
5Master Data APIs
6Order Checking APIs
7Shipment Tracking APIs
8Order Rejection APIs
9Error Handling
10Postman Collection
11Deployment Guide
12Best Practices
13Go-Live Checklist

Business Scenario ​

ตัวอย่าง

Programmer ต้องการพัฒนา Order Checking API

ลำดับการอ่านที่แนะนำคือ

Chapter 1

↓

Chapter 2

↓

Chapter 3

↓

Chapter 4

↓

Chapter 6

ไม่จำเป็นต้องอ่านทั้งเล่มก่อนเริ่มพัฒนา


Documentation Repository Structure ​

text
sisahygo-docs/

docs/
├── 01-introduction/
├── 02-system-overview/
├── 03-api-standards/
├── ...
└── 13-go-live/

assets/
templates/
output/

Key Concepts ​

คำศัพท์ความหมาย
Chapterบทหลักของเอกสาร
Sectionหัวข้อย่อยภายในบท
Documentation RepositoryRepository สำหรับจัดเก็บเอกสาร
Baselineเวอร์ชันอ้างอิงของเอกสาร

Best Practices ​

  • แก้ไขเฉพาะ Section ที่เกี่ยวข้อง
  • Commit ทุกครั้งเมื่อจบหนึ่ง Feature
  • ใช้ Template เดียวกันทุก Chapter
  • อัปเดต Documentation พร้อมการพัฒนา API

Learning Outcomes ​

หลังจากศึกษาหัวข้อนี้แล้ว ผู้อ่านจะสามารถ

  • เข้าใจโครงสร้างของ Documentation Project
  • เลือกบทที่ต้องการศึกษาได้อย่างถูกต้อง
  • เข้าใจวิธีจัดเก็บเอกสารใน Repository

Developer Checklist ​

  • [ ] เข้าใจโครงสร้าง Documentation
  • [ ] เข้าใจลำดับของ Chapter
  • [ ] เข้าใจ Repository Structure

  • Chapter 1 ทั้งหมด

Next Step ​

➡️ 01.06 Version History & Documentation Lifecycle

SISAHYGO API Integration Guide