Tài liệu tham khảo
Tổng quan nhanh
Phần tiêu đề “Tổng quan nhanh”Dùng phần này làm điểm khởi đầu cho tài liệu tham khảo: danh mục API, khóa cấu hình, bảng tương thích, hành vi CSS được hỗ trợ và ghi chú phạm vi trên nhiều gói.
Bản đồ tài liệu tham khảo
Phần tiêu đề “Bản đồ tài liệu tham khảo”| Tài liệu tham khảo | Nội dung giải đáp |
|---|---|
| Ma trận hỗ trợ CSS | Các tính năng CSS được quy trình xử lý HTML kiểm chứng và công bố là được hỗ trợ, hỗ trợ một phần hoặc không hỗ trợ. |
| Chỉ mục API tích hợp | Trang API mở rộng cho biết framework, bộ kết xuất, lớp truyền tải và bề mặt công cụ build nào được bao quát. |
| Các phần tích hợp | Nơi tìm tài liệu tham khảo API và cấu hình dành riêng cho từng gói. |
| Tài liệu tham khảo module Core | Các trang API và kiến trúc cấp module được tạo từ repository core. |
Quy ước cho mỗi mục tham khảo
Phần tiêu đề “Quy ước cho mỗi mục tham khảo”Mọi mục API đều phải trả lời những câu hỏi giống nhau:
| Câu hỏi | Câu trả lời bắt buộc |
|---|---|
| Bạn gọi gì? | Symbol có tên đầy đủ, endpoint, lệnh giao diện dòng lệnh (CLI) hoặc khóa cấu hình. |
| Đầu vào nào được chấp nhận? | Bảng tham số gồm kiểu, mức độ bắt buộc, giá trị mặc định và các giá trị được chấp nhận. |
| Điều gì xảy ra theo mặc định? | Hành vi khi bỏ qua đầu vào tùy chọn. |
| Kết quả trả về là gì? | Kiểu trả về, nội dung phản hồi, tệp đầu ra, luồng hoặc tác dụng phụ. |
| Điều gì có thể thất bại? | Exception, lỗi xác thực, mã trạng thái HTTP hoặc chế độ lỗi khi vận hành. |
| Bạn dùng nó an toàn như thế nào? | Lưu ý về bảo mật, an toàn cho worker, giới hạn kích thước, đường dẫn, thời gian chờ và cách xử lý thông tin bí mật. |
Chính sách về phạm vi
Phần tiêu đề “Chính sách về phạm vi”Các trang tham khảo đều dựa trên mã nguồn. Các API công khai được lập tài liệu từ mã nguồn của gói, tệp cấu hình, kiểm thử và ví dụ. Các lớp helper nội bộ chỉ được lập tài liệu khi nhà phát triển ứng dụng cần hiểu hành vi của chúng để cấu hình hoặc vận hành gói.
Mức độ sẵn sàng cho dịch thuật
Phần tiêu đề “Mức độ sẵn sàng cho dịch thuật”Các trang tham khảo ưu tiên dùng bảng thay vì các đoạn văn dày đặc. Mỗi hàng nên độc lập về nội dung, vì sau này việc phân đoạn theo Extensible Localization Interchange File Format (XLIFF) sẽ tách nội dung thành từng khối.