Trung tâm tri thứcMột tài liệu cần một định danh
Gán mã ổn định cho tài liệu và ghi sản phẩm, phiên bản, ngôn ngữ, đối tượng đọc và nguồn. Một tệp có thể được liên kết từ nhiều trang mà vẫn dùng một bản ghi chính. Tên giống nhau chưa chứng minh nội dung trùng nhau.
Tách ngày trên máy chủ, ngày phát hành trong tài liệu và ngày được rà soát cho dự án. Không tự thay cả ba bằng ngày tải file.
Chốt bộ tài liệu nghiệm thu
Ghi rõ bộ đặc tả và hướng dẫn đã dùng trong thử nghiệm. Khi có cập nhật API, mẫu thiết bị hoặc môi trường, xác định tài liệu nào bị ảnh hưởng và ai kiểm tra lại.
Bản lưu trữ vẫn có giá trị cho dự án cũ. Hãy gắn nhãn rõ và dẫn người triển khai mới đến tài liệu đã được xác nhận phù hợp, thay vì xóa mọi bản trước.
Quản lý bản dịch như một phiên bản liên quan
Bản Việt và Anh cần liên kết bằng mã nội dung, không chỉ bằng tên. Ghi nguồn dịch và thay đổi nội dung để phát hiện khi một bản bị chậm. Các định danh kỹ thuật phải giữ nhất quán.
Nếu tệp nguồn chỉ có một ngôn ngữ, mô tả rõ ngôn ngữ tài liệu. Bản tóm tắt đã dịch không đồng nghĩa tệp tải xuống đã được dịch.
Thiết lập trách nhiệm xuất bản
Đội sản phẩm xác nhận phạm vi, đội kỹ thuật kiểm tra ví dụ, người biên tập kiểm tra cách trình bày và người dịch kiểm tra thuật ngữ. Nếu chưa có người phụ trách, để trống trường dữ liệu thay vì gán tên giả.
Duy trì bảng thay đổi, kiểm tra liên kết và lịch rà soát theo thay đổi sản phẩm. Việc cập nhật có ý nghĩa cần phản ánh ở nội dung, dữ liệu tìm kiếm và siêu dữ liệu cùng lúc.