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. Xem tiến trình.
Trong chương trình Mùa Tài liệu năm 2021, các tổ chức sẽ làm việc trực tiếp với người viết nội dung kỹ thuật để tạo, cải thiện và cập nhật tài liệu. Các tổ chức sẽ trực tiếp chọn tác giả kỹ thuật. Người viết nội dung kỹ thuật muốn hợp tác với tổ chức cần gửi tuyên bố về mối quan tâm bằng cách sử dụng kênh được chỉ định trên trang đề xuất của tổ chức.
Tuyên bố quan tâm nên bao gồm thông tin liên hệ, thông tin về kinh nghiệm viết nội dung kỹ thuật của bạn và phác thảo về công việc bạn sẽ thực hiện với tổ chức. Phần này cũng nên nêu bật cách bạn đáp ứng mọi yêu cầu cụ thể mà tổ chức đặt ra đối với người viết nội dung kỹ thuật. Đọc kỹ trang ý tưởng dự án của tổ chức để đảm bảo bạn đã cung cấp tất cả thông tin họ yêu cầu.
Mẫu này là một bản phác thảo để giúp bạn tạo tuyên bố về sở thích của riêng mình.
Thông tin cá nhân
- Vui lòng cung cấp tên và địa chỉ email của bạn. Nếu bạn không muốn tên của mình được đưa vào báo cáo nghiên cứu điển hình cuối cùng công khai, hãy lưu ý rằng trong đề xuất của bạn và cung cấp tên người dùng.
Thông tin nghề nghiệp
- Một đường liên kết đến danh mục các mẫu viết có thể truy cập công khai hoặc các đường liên kết riêng lẻ đến các ví dụ về tác phẩm của bạn.
- Tổng quan về trải nghiệm gần đây của bạn khi viết nội dung kỹ thuật: Liệt kê vai trò gần đây nhất của bạn khi viết nội dung kỹ thuật hoặc kinh nghiệm làm việc. Nếu bạn có kinh nghiệm về tài liệu nguồn mở, hãy thêm chúng vào đây. Tóm tắt vai trò của bạn, trách nhiệm đảm bảo vai trò và công việc bạn đã hoàn thành. Cung cấp ngày phù hợp.
- Đường liên kết đến sơ yếu lý lịch hoặc sơ yếu lý lịch (CV).
- Nếu tổ chức đặt ra một số yêu cầu nhất định cho dự án, hãy bao gồm một hoặc hai câu mô tả cách bạn đáp ứng các yêu cầu đó, ví dụ: "Tôi đã tham gia hơn sáu bản sửa lỗi tài liệu với tư cách là người viết kỹ thuật và dẫn dắt ba bản sửa lỗi tài liệu cho nhóm của tôi tại XYZ Industries trong năm 2018, 2019 và 2020".
- (Không bắt buộc) Mọi thông tin khác mà bạn muốn thêm. Ví dụ: bạn quan tâm đến tài liệu kỹ thuật, lý do bạn muốn tham gia phần Tài liệu hoặc trải nghiệm có liên quan khác.
Tuyên bố dự án
- Tên dự án. Nếu trang dự án của tổ chức liệt kê nhiều dự án khả thi, hãy đảm bảo tiêu đề tuyên bố mối quan tâm của bạn phản ánh dự án mà bạn muốn thực hiện. Nếu bạn đang gửi tuyên bố quan tâm cho một tổ chức chưa xác định các dự án có thể thực hiện, thì chức danh của bạn phải tóm tắt nội dung mà bạn đang đề xuất. Ví dụ: "Tạo tài liệu tương tác về API ProjectX" là tiêu đề phù hợp hơn "Tài liệu cho ProjectX".
- Nội dung mô tả chi tiết.
- Mô tả cách bạn sẽ triển khai dự án mà tổ chức đã nêu trên trang đề xuất dự án.
- Nêu ra những gì bạn đang đề xuất sẽ giải quyết vấn đề hoặc đạt được mục tiêu mà tổ chức đã đặt ra trên trang đề xuất dự án của họ.
- Bao gồm bản tóm tắt mọi cuộc thảo luận giữa bạn và các thành viên của tổ chức về dự án này.
- Hãy chú ý đến ngôn ngữ và kiểu đề xuất của bạn. Tổ chức nguồn mở có thể sử dụng những mã này làm yếu tố đánh giá đề xuất của bạn.
- Tiến trình đề xuất
- Đưa ra phác thảo chung về tiến trình và các giai đoạn của dự án. Ví dụ: bạn có thể đặt ngân sách là 2 tuần cho hoạt động thu thập thông tin, 4 tuần để viết, 2 tuần cho việc xem xét và thay đổi, và 1 tuần cho việc xuất bản.
- Nêu rõ kỳ vọng rõ ràng về sự tham gia và ý kiến phản hồi của các thành viên trong dự án. Ví dụ: bạn có thể tuyên bố rằng tiến trình của bạn phụ thuộc vào việc nhận được câu trả lời cho các câu hỏi trong vòng 3 ngày.
- Ngân sách được đề xuất
- Người viết nội dung kỹ thuật nên đề xuất ngân sách cho toàn bộ dự án thay vì mức giá theo giờ.
- Nếu có thể, hãy đưa ra các lựa chọn để giảm phạm vi hoặc tăng phạm vi. Ví dụ: Bạn có thể đưa ra nhiều mức ngân sách để ghi lại hướng dẫn triển khai cho 2, 4 hoặc 6 nền tảng.