Giai đoạn hiện tại:
Chương trình Season of Docs 2021 đã kết thúc vào ngày 14 tháng 12 năm 2021. 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ới thiệu cho người viết nội dung kỹ thuật về thế giới nguồn mở và cộng đồng của bạn
- 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 gia những cuộc họp định kỳ nào hoặc họ nên 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 họ với một vài người ở múi giờ chồng chéo nhau, những người này 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ố phần quà dự án!
Giúp người viết nội dung kỹ thuật sử dụng các công cụ và quy trình liên quan đến việc đóng góp cho dự án của bạn
- Nếu quy trình của bạn chưa được ghi nhận đầy đủ, hãy sắp xếp thời gian để trao đổi với 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ọ. Công ty 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 công việc của họ có chứa đoạn mã mẫu, thì 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úp người viết kỹ thuật hiểu dự án của bạn và người dùng của dự á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 sẽ nhận được thời gian và tài nguyên cần thiết từ các chuyên gia trong lĩnh vực này và bất kỳ thành viên nào khác trong cộng đồng.
Hãy đặt câu hỏi!
- 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 để học hỏi trong khi chia sẻ những gì bạn biết! 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.