กติกาการดูแล Wiki
repo นี้มองว่า wiki เป็น engineering artifact ไม่ใช่เอกสารเสริมที่ค่อยมาเขียนทีหลัง
กติกาหลัก
เมื่อ flow ของระบบในแอปเปลี่ยน ต้องอัปเดตหน้าที่เกี่ยวข้องใน wiki ภายในงานเดียวกันเป็นค่าเริ่มต้น
ตัวอย่าง:
- login หรือ session behavior เปลี่ยน
- branch selection logic เปลี่ยน
- home navigation หรือ menu gating เปลี่ยน
- sales, payment, printer, scanner หรือ customer-display flow เปลี่ยน
- Android setup หรือ release step เปลี่ยน
แนวปฏิบัติ
- ถ้า code change กระทบ user-visible flow ให้แก้ workflow page ที่ตรงกันใน
docs-site/docs/ - ถ้า architecture หรือขอบเขตความรับผิดชอบเปลี่ยน ให้แก้ architecture page
- ถ้า setup หรือ release step เปลี่ยน ให้แก้ setup page
- ถ้าการเปลี่ยนแปลงนั้นควรถูกติดตามตามเวลา ให้เพิ่ม entry ใน
governance/change-log - ถ้าเป็น change เล็กแต่มีประโยชน์ต่อประวัติโปรเจกต์ ให้ prefer การใส่ changelog entry แบบสั้นแทนการไม่บันทึก
- ถ้ายังไม่มีหน้าที่เหมาะสม ให้สร้างหน้าใหม่แทนการปล่อยให้ undocumented