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:
Nghiên cứu điển hình đã xuất bản. Xem tiến trình.

Dưới đâ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 nhà văn kỹ thuật.

Hướng dẫn cho người viết nội dung kỹ thuật về cộng đồng của bạn. Họ có thể đặt câu hỏi ở đâu? Họ nên tham dự cuộc họp thường xuyên nào hoặc nên tham gia 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 và có thể phản hồ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 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 nhà văn 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 mẫu hoặc thẻ nào? Ai cần xem xét nội dung đóng góp của họ, cũng như cách thức và thời điểm họ cần theo dõi các bài đánh giá? Nếu bài tập của họ bao gồm các mẫu mã, làm cách nào để kiểm thử các mẫu mã đó? Họ cần biết điều gì về quy trình hoặc bản phát hành CI/CD 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 hiểu biết vững chắc 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ó 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à 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à các nhà phát triển hoặc cộng tác viên khác của dự án chịu trách nhiệm về các khía cạnh của 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ó 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 người đóng góp tài liệu. Hãy tận dụng cơ hội để học hỏi trong khi chia sẻ những gì bạn biết! Yêu cầu ý kiến phản hồi về quy trình và công cụ của bạn – nhà văn kỹ thuật có thể sẽ đưa ra một số đề xuất để cải thiện.