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.
Trang này cung cấp các mẹo dành cho các tổ chức nguồn mở về cách đánh giá và chọn người viết nội dung kỹ thuật phù hợp cho đề xuất dự án Google Season of Docs.
Giới thiệu
Tổ chức nguồn mở phải thuê một người viết kỹ thuật để làm việc trên dự án đề xuất của họ. Các tổ chức phải tự tìm nguồn nhà văn kỹ thuật. Những người viết nội dung kỹ thuật quan tâm đến việc hợp tác với các tổ chức tham gia vào Google Season of Tài liệu có thể được tìm thấy trong kho lưu trữ GitHub của Google Season of Tài liệu và #season-of-docs trong Slack Write the Tài liệu.
Đánh giá tác giả kỹ thuật
Bạn nên yêu cầu các ví dụ về tài liệu đã phát triển trước đó từ những người viết kỹ thuật mà bạn đang cân nhắc để có thể tập trung đánh giá kỹ năng và kinh nghiệm viết kỹ thuật của họ.
Kỹ năng và kinh nghiệm viết kỹ thuật
Kiểm tra kinh nghiệm trước đây của người viết nội dung kỹ thuật. Tốt nhất là người viết tài liệu kỹ thuật phải có một số kinh nghiệm trước đó về việc viết tài liệu kỹ thuật cho ngành phần mềm. Một trong những mục tiêu của Google Season of Docs là tạo cơ hội cho các nhà văn kỹ thuật tham gia vào các sản phẩm tập trung vào nhà phát triển. Do đó, người viết không nhất thiết phải có kinh nghiệm về API hoặc SDK hay các nền tảng khác dành cho nhà phát triển, ngay cả khi dự án của bạn tập trung vào đối tượng nhà phát triển.
Tập trung vào kỹ năng ngôn ngữ và giao tiếp. Đánh giá công việc trước đây của người viết nội dung kỹ thuật từ quan điểm này. Quan trọng nhất là: Bạn có thể hiểu được người đó viết gì không? Nếu bạn muốn xem xét kỹ lưỡng ngôn ngữ của tác phẩm của người viết kỹ thuật, hãy tìm sự nhất quán trong dấu câu và cách diễn đạt, chính tả chính xác và ngôn ngữ rõ ràng. Cách diễn đạt đơn giản hay phức tạp? Các câu có ngắn gọn hay dài dòng đến mức khó theo dõi không?
Chú ý đến thiết kế và bố cục của tài liệu. Kiểm tra bố cục tổng thể của(các) mẫu tài liệu. Thiết kế có hợp lý không? Bạn có thể dễ dàng tìm thấy tài liệu hoặc bộ tài liệu không? Nội dung có trùng lặp hay có khoảng trống rõ ràng không?