Skip to content

01.06 Version History และ Documentation Lifecycle ​


📌 At a Glance ​

รายการรายละเอียด
TopicVersion Management
Difficulty⭐ Beginner
Reading Time5 นาที
TargetDeveloper / Project Manager

⏱ Reading Time ​

ประมาณ 5 นาที


🎯 Learning Objectives ​

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

  • เข้าใจ Version ของ API และ Documentation
  • เข้าใจการออกรุ่น (Release)
  • เข้าใจการอัปเดตเอกสาร

Overview ​

SISAHYGO แยก Version ของ API และ Documentation ออกจากกัน เพื่อให้สามารถพัฒนาและเผยแพร่เอกสารได้อย่างอิสระ

ทุกครั้งที่มีการเปลี่ยนแปลง API จะต้องมีการอัปเดต Documentation ให้สอดคล้องกัน


Business Value ​

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

  • ลูกค้าทราบว่ากำลังใช้งาน API เวอร์ชันใด
  • ลดปัญหาจากเอกสารไม่ตรงกับระบบ
  • ตรวจสอบประวัติการเปลี่ยนแปลงได้

Technical Overview ​

ปัจจุบัน

รายการVersion
APIV1.1
DocumentationV1.0

ในอนาคต

APIDocumentation
V1.2V1.1
V2.0V2.0

Documentation Lifecycle ​

text
Design

↓

Development

↓

Review

↓

Release

↓

Maintenance

↓

Next Version

Release Policy ​

ทุก Feature ใหม่ของ API จะถือว่าเสร็จสมบูรณ์เมื่อ

  • พัฒนา API เสร็จ
  • ผ่านการทดสอบ
  • อัปเดต Postman Collection
  • อัปเดต Documentation
  • เพิ่ม Release Note

Version History ​

DateAPIDocumentationDescription
Jul 2026V1.1V1.0Initial Release

Key Concepts ​

คำศัพท์ความหมาย
API Versionเวอร์ชันของระบบ API
Documentation Versionเวอร์ชันของเอกสาร
Releaseการเผยแพร่เวอร์ชัน
Changelogประวัติการเปลี่ยนแปลง

Best Practices ​

  • Documentation ต้องอัปเดตพร้อม Code
  • ทุก Release ต้องมี Changelog
  • ใช้ Semantic Versioning สำหรับ API

Learning Outcomes ​

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

  • เข้าใจการจัดการ Version
  • เข้าใจ Release Process
  • เข้าใจ Documentation Lifecycle

Developer Checklist ​

  • [ ] เข้าใจ Version Policy
  • [ ] เข้าใจ Release Process
  • [ ] พร้อมศึกษาบทถัดไป

  • Chapter 3 API Standards

Next Step ​

➡️ Chapter 2 : System Overview

SISAHYGO API Integration Guide