47.29.Checklist biên tập tài liệu kỹ thuật (Technical-document editing checklist)

100%

Định nghĩa: Tài liệu kỹ thuật cần thêm lớp kiểm tra về terminology và instruction grammar.

Cách dùng: Dùng Checklist biên tập tài liệu kỹ thuật như một bảng kiểm tra nhanh; tìm hàng phù hợp với cấu trúc đang viết rồi đối chiếu lại ví dụ trước khi áp dụng.

Văn phong/ngữ cảnh: Các bảng được thiết kế cho tra cứu nhanh trong mọi register; không nên hiểu một ô tóm tắt là toàn bộ quy tắc.

Ví dụ

Trong hướng dẫn an toàn, must not phải được dùng nhất quán nếu ý nghĩa là cấm, tránh thay bằng do not have to.

Imperative có rõ tác nhân không?
Điều kiện if/unless/when có phạm vi rõ không?
must/should/may có dùng nhất quán không?
Số, đơn vị và tolerance có rõ không?
Noun strings có mơ hồ không?
Warning có dùng phủ định gây hiểu nhầm không?
Thuật ngữ có nhất quán xuyên tài liệu không?