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ông bố 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.

Cung cấp cho người viết nội dung kỹ thuật 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 gia những cuộc họp định kỳ nào hoặc những danh sách gửi thư nào họ nên tham gia? Họ cần có tài khoản nào (Github, Discord, Slack)? Hãy đả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 người viết 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 những người sử dụng lao độ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 họ với một vài người ở các múi giờ chồng chéo. Họ có thể trả lời nhanh 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 dự án!

Nếu các quy trình của bạn không có đầy đủ tài liệu, hãy sắp xếp 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 của họ. Họ nên sử dụng những mẫu hoặc thẻ nào? Ai cần phải đánh giá nội dung đóng góp của mình, họ nên theo dõi các bài đánh giá đó bằng cách nào và khi nào? Nếu công việc của họ có chứa các mã mẫu, làm cách nào để kiểm tra các mã đó? Họ cần biết gì về các bản phát hành hoặc quy trình CI/CD của bạn?

Giải thích dự án của bạn một cách chi tiết để người viết 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 và có căn cứ đáng tin hơn khi viết nội dung 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ất có thể – không chỉ "nhà phát triển" mà còn cả "nhà phát triển tạo trang web" cũng như "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 phụ trách vấn đề cần thiết. Tức là những nhà phát triển hoặc những người đóng góp khác cho dự án sẽ chịu trách nhiệm về các khía cạnh có trong tài liệu của bạn.
Đả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 ngành 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 hợp tác với người viết nội dung kỹ thuật hoặc người đóng góp tài liệu. Hãy tận dụng cơ hội để học hỏi bằng cách chia sẻ kiến thức của bạn! Xin ý kiến phản hồi về các quy trình và công cụ của bạn – người viết kỹ thuật có thể sẽ đưa ra một số đề xuất để cải thiện.