โหมดมืด
วิธีใช้คู่มือนี้
เอกสารชุดนี้จัดด้วยสามแกนที่ตัดกัน คุณจะเจอสิ่งที่ต้องการเร็วที่สุดถ้าเลือกแกนให้ตรงกับสิ่งที่คุณรู้อยู่แล้ว
แกนที่หนึ่งคือ บทบาท ใช้เมื่อคุณรู้ว่าตัวเองทำหน้าที่อะไรแต่ยังไม่รู้ว่าระบบเรียกสิ่งนั้นว่าอะไร แกนที่สองคือ โมดูล ใช้เมื่อคุณรู้แล้วว่างานอยู่ที่ KlevIQ Flow หรือ ALZO ERP แกนที่สามคือ หัวข้อ (tag) ใช้เมื่อคุณสนใจเรื่องหนึ่งข้ามโมดูล เช่นทุกอย่างที่เกี่ยวกับสิทธิ์ผู้ใช้หรือทุกอย่างที่เกี่ยวกับการเชื่อมต่อ
บทบาทผู้อ่านห้ากลุ่ม
| บทบาท | คำถามในหัว | เหมาะกับ |
|---|---|---|
USER ผู้ใช้หน้างาน | งานตรงหน้าทำยังไง | พนักงานขาย คลัง ผลิต บัญชี ที่ทำงานประจำวันในระบบ |
MANAGER หัวหน้างาน | ดูภาพรวมและคุมงานยังไง | หัวหน้าแผนก ผู้จัดการ เจ้าของกิจการ |
ADMIN ผู้ดูแลระบบ | ตั้งค่าและดูแลระบบยังไง | ผู้ดูแลระบบฝ่ายลูกค้า ฝ่าย IT |
PARTNER พาร์ทเนอร์ | พาลูกค้าใหม่ขึ้นระบบยังไง | ตัวแทนจำหน่ายและผู้วางระบบที่ได้รับอนุญาต |
DEV นักพัฒนา | ต่อ API และขยายระบบยังไง | นักพัฒนาฝั่งลูกค้าและผู้เชื่อมระบบภายนอก |
หนึ่งหน้ามีบทบาทหลักหนึ่งบทบาท (ป้ายซ้ายสุด) และมีบทบาทรองได้ไม่เกินสองบทบาท ถ้าหน้าไหนแปะครบทุกบทบาท แปลว่าหน้านั้นยังไม่ได้เขียนเจาะใครและควรถูกผ่าออก
ประเภทเนื้อหาห้าแบบ
เราแยกประเภทเนื้อหาตามแนวคิด Diátaxis เพราะคนอ่านคู่มือด้วยเจตนาต่างกันคนละเวลา ไม่ควรผสมในหน้าเดียว
ทำความเข้าใจ อธิบายว่าอะไรคืออะไรและทำไมต้องมี อ่านตอนเริ่มต้นหรือตอนสงสัยว่าทำไมระบบคิดแบบนี้ เริ่มต้นทีละขั้น พาทำจนสำเร็จครั้งแรกโดยไม่ต้องตัดสินใจอะไรเอง วิธีทำงาน ทำงานหนึ่งอย่างให้เสร็จ สมมติว่าคุณรู้บริบทแล้ว อ้างอิง ตารางฟิลด์ ค่าที่รับได้ พารามิเตอร์ API ไม่มีเรื่องเล่า แก้ปัญหา เรียงตามอาการที่เห็น ไม่ใช่ตามสาเหตุ
ชั้นการเข้าถึง
หน้าที่มีสัญลักษณ์ 🔒 คือเอกสารชั้นพาร์ทเนอร์หรือชั้นภายใน ถ้าคุณเห็นมันได้แปลว่าคุณกำลังอ่านเว็บชั้นนั้นอยู่ อ่านต่อที่ ชั้นเอกสารและสิทธิ์การเข้าถึง