Giai đoạn hiện tại:
Chương trình Phần Tài liệu năm 2019 đã kết thúc vào ngày 6 tháng 3 năm 2020. Hãy xem dòng thời gian.
Trang này chứa các nguyên tắc dành cho các tổ chức nguồn mở về cách đánh giá các đề xuất viết dự án kỹ thuật và chọn dự án mà họ muốn cố vấn trong Phần Tài liệu.
Giới thiệu
Người viết nội dung kỹ thuật gửi đề xuất về Phần Tài liệu để làm việc trong một dự án thông qua tổ chức nguồn mở đã chọn. Quản trị viên chương trình của Google sẽ chuyển tiếp đề xuất đến các tổ chức nguồn mở để đánh giá và lựa chọn dự án. Để biết thông tin chi tiết về các bước liên quan, hãy xem hướng dẫn dành cho quản trị viên của tổ chức.
Đánh giá các đề xuất của người viết kỹ thuật
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. Đề xuất của người viết kỹ thuật bao gồm thông tin về trải nghiệm mới nhất khi viết nội dung kỹ thuật. Tốt nhất là người đăng ký 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 tập trung vào nhà phát triển. Do đó, người viết không cần 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 ngôn ngữ và kỹ năng giao tiếp. Hãy đánh giá đề xuất của người viết nội dung kỹ thuật từ góc nhìn này. Quan trọng nhất: Bạn có thể hiểu được người đó viết gì không? Với vai trò cố vấn, vai trò của bạn sẽ là giúp người viết kỹ thuật về các quy trình, công cụ và mã nguồn mở. Bạn sẽ không muốn phải xem lại văn bản của tài liệu thu được. Nếu bạn muốn đánh giá sâu về ngôn ngữ của đề xuất, hãy tìm tính nhất quán trong dấu câu và cụm từ, đúng chính tả 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 không hay chúng chạy liên tục cho đến khi trở nên khó theo dõi?
Chú ý đến thiết kế và bố cục của tài liệu. Trong đề xuất của họ, người viết nội dung kỹ thuật có cơ hội cung cấp ví dụ về các tài liệu mà họ đã phát triển. 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?
Đề xuất
Kiểm tra để đảm bảo đề xuất phù hợp với các yêu cầu của bạn. Đề xuất này có liên quan đến bất kỳ ý tưởng dự án nào mà bạn đã gửi cho Mùa Tài liệu năm nay không? Nếu người viết kỹ thuật đã đề xuất một ý tưởng mới, hãy kiểm tra xem đề xuất đó có phù hợp với nhu cầu của dự án nguồn mở của bạn hay không và bạn có người phù hợp để giúp người viết kỹ thuật đạt được mục tiêu của dự án đã đề xuất.
Tìm sự nhiệt tình và sự thấu hiểu. Đề xuất có chứng minh rằng người viết nội dung kỹ thuật có hào hứng với dự án này không? Hãy cân nhắc xem họ đã suy nghĩ và nỗ lực thực hiện vào đề xuất chưa, bằng cách tham khảo ý kiến của tổ chức của bạn trong giai đoạn khám phá hoặc bằng cách thêm suy nghĩ của riêng họ về cách đạt được mục tiêu của dự án.
Câu hỏi thường gặp
Làm cách nào để chúng tôi xác định số lượng dự án cần gửi?
Tập trung vào một hoặc hai dự án. Nếu tổ chức của bạn có năng lực để cố vấn nhiều hơn thế, thì bạn có thể gửi thêm. Đối với mỗi dự án người viết kỹ thuật, bạn cần có ít nhất một người cố vấn (tốt nhất là hai) người cam kết chỉ cố vấn cho dự án đó.
Đọc thông tin về cách phân bổ vị trí của Phần Tài liệu.
Làm cách nào để chọn chấp nhận một bản đề xuất kỹ thuật bằng văn bản?
Hãy nhớ chọn đề xuất hay nhất của nhà văn kỹ thuật mà bạn nhận được. Điều đó nghĩa là, hãy chọn những đề xuất phù hợp nhất với yêu cầu của bạn cũng như phù hợp nhất với nguyên tắc đánh giá nêu trên.