เฟรมเวิร์กและไลบรารี
- เริ่มต้นใช้งานได้เร็วที่สุดเท่าที่เป็นไปได้
- อัปเกรดได้ง่าย
- ข้อความแสดงข้อผิดพลาดที่มีประโยชน์
- ค่าเริ่มต้นและคอนเวนชันที่แข็งแกร่ง
- ทำให้สามารถหลุดออกจากการตั้งค่าเริ่มต้นได้
- ลดความเสี่ยงด้วยการพึ่งพาไลบรารี
เอกสาร
- อธิบายด้วยโค้ด (มีตัวอย่างให้)
- ช่วยแก้ปัญหา (ตอบคำถาม)
- สร้างเอกสารอัตโนมัติ (เช่น เอกสาร API ที่อัปเดตอยู่เสมอ)
- จัดทำแนวทางแก้ไขสำหรับข้อผิดพลาดไว้ด้วย
- ปรับให้เหมาะกับการอ่านผ่านๆ (Skimming)
- ต้องแม่นยำ (หลีกเลี่ยงศัพท์เฉพาะและสำนวน)
- ค่อยๆ เปิดเผยเรื่องที่ซับซ้อนอย่างเป็นลำดับ
API
- อย่าทำให้เวิร์กโฟลว์ของ API พัง (Versioning) : เช่นเดียวกับ Stripe
- ควรทำให้สามารถทดสอบ API ได้อย่างรวดเร็ว : Square ทำเรื่องนี้ได้ดี
1 ความคิดเห็น
"การปรับให้เหมาะกับการอ่านแบบกวาดตา" นี่เห็นด้วยมากเลย