Điều gì tạo nên trải nghiệm nhà phát triển (DX) tuyệt vời?

Framework và thư viện

• Có thể onboarding nhanh nhất có thể
• Dễ nâng cấp
• Thông báo lỗi hữu ích
• Giá trị mặc định và quy ước mạnh mẽ
• Cho phép thoát khỏi cấu hình mặc định
• Giảm rủi ro thông qua dependency

Tài liệu

• Giải thích bằng code (cung cấp ví dụ)
• Giải quyết vấn đề (trả lời câu hỏi)
• Tự động tạo tài liệu (giữ tài liệu API và các tài liệu khác luôn được cập nhật)
• Cũng tổng hợp cách xử lý lỗi
• Tối ưu cho việc đọc lướt
• Chính xác (tránh thuật ngữ chuyên môn và thành ngữ)
• Với những phần phức tạp, hãy trình bày dần dần

API

• Không phá vỡ workflow của API (versioning): như Stripe
• Cho phép thử nghiệm API nhanh chóng: Square làm điều này rất tốt

[laeyoung]

"Tối ưu hóa cho việc đọc lướt" là điều mình cực kỳ đồng cảm.