Trang này được dịch bởi Cloud Translation API.

Hợp tác với nhà văn kỹ thuật

Giai đoạn hiện tại:
Phát triển tài liệu. Xem tiến trình.

Sau đây là một số nguyên tắc giúp các tổ chức nguồn mở làm việc hiệu quả với người viết nội dung kỹ thuật.

Đưa người viết nội dung kỹ thuật tham gia một "chuyến tham quan có hướng dẫn viên" về cộng đồng của bạn. Họ có thể đặt câu hỏi ở đâu? Họ nên tham dự những cuộc họp định kỳ nào hoặc nên tham gia danh sách gửi thư nào? Họ cần có tài khoản nào (GitHub, Discord, Slack)? Hãy đảm bảo họ hiểu quy tắc ứng xử của dự án và biết cách báo cáo mọi vấn đề. Hãy đảm bảo người viết nội dung kỹ thuật của bạn hiểu rõ giấy phép của dự án và tuân thủ mọi yêu cầu của các chủ lao động khác về việc ký Thoả thuận cấp phép nội dung, DCO hoặc các thoả thuận khác.
Nếu có thể, hãy giới thiệu họ với một vài người ở các múi giờ trùng lặp. Họ có thể nhanh chóng trả lời các câu hỏi về cộng đồng hoặc dự án.
Nếu có thể, hãy gửi cho họ một vài món quà dự án!

Nếu quy trình của bạn không có đầy đủ tài liệu, hãy dành thời gian để hướng dẫn người viết nội dung kỹ thuật về nội dung đóng góp, vấn đề hoặc yêu cầu lấy dữ liệu đầu tiên. Họ nên sử dụng mẫu hoặc thẻ nào? Ai cần đánh giá nội dung đóng góp của họ, và làm thế nào và khi nào họ nên tiếp tục xem xét các bài đánh giá? Nếu công việc của họ bao gồm mã mẫu, làm cách nào để kiểm thử chúng? Họ cần biết gì về quy trình CI/CD hoặc các bản phát hành của bạn?

Giải thích chi tiết về dự án của bạn để người viết nội dung kỹ thuật có được sự hiểu biết chắc chắn về khái niệm của sản phẩm. Điều này có thể giúp người viết nội dung kỹ thuật cảm thấy tự tin hơn và có căn cứ đáng tin hơn khi viết bài về dự án.
Mô tả nhu cầu của những người sử dụng dự án. Hãy nêu cụ thể như bạn có thể, không chỉ "nhà phát triển" mà còn "nhà phát triển tạo trang web" và "nhà phát triển lập trình rô-bốt công nghiệp".
Giúp người viết nội dung kỹ thuật liên hệ với các chuyên gia trong lĩnh vực cần thiết. Tức là những nhà phát triển hoặc người đóng góp cho dự án khác chịu trách nhiệm về các khía cạnh trong dự án mà tài liệu sẽ đề cập.
Đảm bảo rằng người viết nội dung kỹ thuật có được thời gian và tài nguyên cần thiết từ các chuyên gia trong lĩnh vực và mọi thành viên khác trong cộng đồng.

Có thể cộng đồng hoặc dự án của bạn chưa từng hợp tác với tác giả kỹ thuật hoặc người đóng góp tài liệu. Hãy tận dụng cơ hội này để học hỏi đồng thời chia sẻ những gì bạn biết! Yêu cầu ý kiến phản hồi về các quy trình và công cụ của bạn — người viết nội dung kỹ thuật của bạn có thể sẽ có một số đề xuất để cải thiện.