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:
Kết quả đã được công bố. 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 các nhà văn kỹ thuật.

Giúp người viết nội dung kỹ thuật "tham quan có hướng dẫn viên" về cộng đồng của bạn. Người dùng có thể đặt câu hỏi ở đâu? Họ nên tham dự những cuộc họp thường xuyên nào hoặc tham gia những danh sách gửi thư nào? Họ cần có những tài khoản nào (GitHub, Discord, Slack)? Đảm bảo họ hiểu rõ quy tắc ứng xử của dự án và biết cách báo cáo mọi vấn đề. Đảm bảo rằng người viết nội dung kỹ thuật 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 nhà tuyển dụng khác về việc ký CLA, DCO hoặc các thoả thuận khác.
Nếu có thể, hãy giới thiệu cho họ một vài người ở múi giờ trùng lặp để 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 số quà tặng của dự án!

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

Giải thích chi tiết dự án của bạn để người viết nội dung kỹ thuật có được khái niệm vững chắc về 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ó uy tín hơn trong việc viết nội dung cho dự án.
Mô tả nhu cầu của những người sử dụng dự án. Hãy cụ thể nhất có thể – không chỉ là "nhà phát triển" mà còn là "nhà phát triển tạo trang web" và "nhà phát triển lập trình robot công nghiệp".
Liên hệ giữa người viết nội dung kỹ thuật với các chuyên gia cần thiết về chủ đề. Tức là những nhà phát triển hoặc những người đóng góp khác cho dự án chịu trách nhiệm về những khía cạnh trong dự án của bạ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ó đủ thời gian và tài nguyên cần thiết từ các chuyên gia về chủ đề và mọi thành viên khác trong cộng đồng.

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