Giai đoạn hiện tại:
Chương trình Phần Tài liệu năm 2021 đã kết thúc vào ngày 14 tháng 12 năm 2021. Hãy xem dòng thời gian.
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 Mùa Tài liệu.
Giới thiệu
Tổ chức nguồn mở phải thuê một người viết nội dung kỹ thuật để thực hiện dự án mà họ đề xuất. Các tổ chức phải có nguồn gốc từ người viết kỹ thuật của riêng mình. Các tác giả về kỹ thuật quan tâm đến việc hợp tác với các tổ chức tham gia Phần Tài liệu có thể xem trong kho lưu trữ Phần tài liệu trên GitHub và trong kênh#mùa-tài liệu của Slack viết tài liệu.
Đánh giá một người viết nội dung kỹ thuật
Bạn nên yêu cầu ví dụ về các tài liệu đã phát triển trước đây của những người viết nội dung 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 kỹ thuật. Tốt nhất là người viết kỹ thuật nên có một số kinh nghiệm 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 Phần Tài liệu là mang đến cho người viết nội dung kỹ thuật cơ hội tham gia vào các sản phẩm dành cho 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 hoặc các nền tảng 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 ngôn ngữ và kỹ năng giao tiếp. Từ góc nhìn này, hãy đánh giá tác phẩm trước đây của người viết nội dung kỹ thuật. Quan trọng nhất: Bạn có thể hiểu được người đó viết gì không? Nếu bạn muốn đánh giá sâu về ngôn ngữ trong tác phẩm của nhà văn kỹ thuật, hãy đảm bảo tính nhất quán trong dấu câu và cụm từ, cách viết đúng chính tả và ngôn từ rõ ràng. Cách diễn đạt đơn giản hay phức tạp? Các câu có ngắn hay dài cho đến khi trở nên 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 ra tài liệu hoặc bộ tài liệu không? Có nội dung trùng lặp hoặc có khoảng trống rõ ràng không?