Trình bày tài liệu
- Không viết hoa:
- Thế thì GraphQL hoạt động như thế nào? ta dùng nó như thế nào?
- Một số từ tiếng Anh phổ biến thì nên dịch ra, ví dụ như: application, format, load data, avatar,...
- Tab:
- GraphQL như là một tầng(layer), Những khái niệm đầu tiên về REST(REpresentational State Transfer), trường(field).
- phát triển,bảo trì
- Sai chính tả: phần mếm
- Không đồng nhất khi viết hoa:
- Từ đó có thêm một vấn đề khác xuất hiện: trong khi posts - Giải pháp mà Facebook đưa ra đến từ một ý tưởng rất đơn giản: Thay vì có rất nhiều "endpoint"...
Nội dung tài liệu
- Dùng từ chưa chính xác:
- (người dùng) GraphQL do Facebook tạo ra từ năm 2012 cung cấp giao thức chung cho phép giao tiếp giữa người dùng (client) và máy chủ (server) để cập nhật và lấy dữ liệu.
- Phần "Công cụ giúp chuyển đổi từ REST sang GraphQL tự động" chưa có mô tả giới thiệu, chỉ có mình link.
- Trong phần Tổng quan về GraphQL nhóm có nêu về "Thế thì GraphQL hoạt động như thế nào? ta dùng nó như thế nào?" nhưng chưa nói trong phần này.
Giao diện Website
- Thiếu phần Copyright.
- Phần giao diện về tài liệu chưa có tiêu đề "Tài liệu" như các phần "Giới thiệu, Dịch vụ".
Tổng kết:
- Tài liệu chia nhỏ đặt ở nhiều thư mục. Ví dụ: phần tài hướng dẫn cài đặt và tài liệu về GraphQL nên đặt chung trong 1 file, vì người đọc thường không tìm kiếm ở nhiều thư mục khác nhau để đọc tài liệu.
- Chưa đảm bảo về độ dài.
- Có làm giao diện trên Website giới thiệu về GraphQL, giao diện khá đẹp và khả dụng với người dùng.
- Bố cục tài liệu rõ ràng.
- Có trích dẫn nguồn và tài liệu tham khảo để mọi người có thể đọc hiểu thêm.
Nhóm: 9.0/10