Giai đoạn hiện tại:
Nghiên cứu điển hình đã xuất bản. 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 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. Bạn có thể tìm thấy các nhà văn kỹ thuật muốn làm việc với các tổ chức tham gia Google Season of Docs trong kho lưu trữ GitHub của Google Season of Docs và trong kênh#season-of-docs trên Slack của Write the Docs.
Bắt đầu quy trình
Bạn nên bắt đầu tìm kiếm một nhà văn kỹ thuật ngay khi bạn nghĩ rằng mình có thể muốn tham gia Google Season of Docs.
Đánh giá nhân viên viết tài liệu 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ừ các nhà văn kỹ thuật mà bạn đang cân nhắc để có thể đá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 tài liệu 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. Vì lý do đó, không nhất thiết là người viết phải có kinh nghiệm về API, SDK hoặc các nền tảng dành cho nhà phát triển khác, 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: Bạn có hiểu được nội dung người đó viết 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?
Thuê người viết tài liệu kỹ thuật
Các tổ chức phải thuê một người viết nội dung kỹ thuật và hoàn tất Biểu mẫu bằng chứng về việc thuê người viết nội dung kỹ thuật được liên kết ở bên dưới muộn nhất vào 18:00 (giờ UTC) ngày 22 tháng 5 năm 2024.
Đã hoàn tất giai đoạn tuyển dụng nhân viên viết nội dung kỹ thuật.
Hãy nhớ thảo luận về mức thù lao và lịch thanh toán với nhà văn kỹ thuật trước khi tuyển dụng. Các tổ chức nên tạo lịch thanh toán với người viết nội dung kỹ thuật dựa trên các mốc quan trọng của dự án, bao gồm cả khoản thanh toán khi bắt đầu dự án. Hãy lưu ý đến ngày thanh toán (chỉ diễn ra hai lần trong suốt chương trình) và số tiền khi tạo lịch thanh toán.
Lưu ý: Những tổ chức chưa thuê nhà văn kỹ thuật và gửi Biểu mẫu bằng chứng về việc thuê nhà văn kỹ thuật muộn nhất vào lúc 18:00 (giờ UTC) ngày 22 tháng 5 năm 2024 sẽ không nhận được tiền vào ngày thanh toán đầu tiên.