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.
Hướng dẫn này dành cho những quản trị viên tổ chức đăng ký hoặc tham gia chương trình Phần mềm Tài liệu năm 2021.
Tổ chức của bạn có nên tham gia chương trình Tài liệu mùa hè năm 2021 không?
Sử dụng những câu hỏi này để giúp bạn biết liệu dự án nguồn mở hoặc tổ chức của mình có nên tham gia Phần Tài liệu hay không.
Tổ chức hoặc dự án của bạn:
- Bạn có cho rằng tài liệu mới hoặc được cập nhật sẽ giúp đạt được mục tiêu hoặc giải quyết vấn đề trong dự án hoặc cộng đồng của bạn không?
- Bạn đã có hiểu biết ban đầu hoặc có đặt giả thuyết về cách thức đo lường mức độ thành công của dự án lập tài liệu chưa?
- Các thành viên trong cộng đồng có sẵn lòng giúp tuyển dụng, đánh giá và thêm một người viết nội dung kỹ thuật hay không, và ai có thể sẵn lòng trả lời các câu hỏi cũng như cung cấp các sự hỗ trợ khác trong suốt dự án (6-8 tháng, kể cả thời gian đăng ký)?
- Có một thành viên trong cộng đồng sẵn sàng làm quản trị viên của tổ chức và phối hợp tạo đơn đăng ký, trả lời các câu hỏi của quản trị viên chương trình, cũng như gửi bản đánh giá cũng như bản đánh giá cuối cùng và nghiên cứu điển hình không? Quản trị viên của tổ chức cũng phải sẵn lòng trả lời các bản khảo sát tiếp theo sau khi hoàn thành Mùa giải Tài liệu năm 2021.
Tổ chức của bạn cũng phải đáp ứng các yêu cầu của chương trình, bao gồm cả việc tạo tài khoản Open Collective.
Quy trình đăng ký của tổ chức
Giai đoạn khám phá
Mặc dù mùa đăng ký Tài liệu năm 2021 sẽ bắt đầu vào ngày 9 tháng 2 năm 2021, nhưng các tổ chức nên dành thời gian để hoàn tất các bước trong giai đoạn Khám phá trước khi gửi đơn đăng ký.
- Tạo trang đề xuất dự án. Trang đề xuất bao gồm một danh sách các nhu cầu, mục tiêu hoặc vấn đề chính, các giải pháp tài liệu có thể có và các chỉ số có thể có. Trang này phải ở chế độ công khai và cho phép cộng đồng đóng góp và thảo luận. Cung cấp thông tin cho người viết nội dung kỹ thuật muốn tham gia – họ nên đặt câu hỏi, bày tỏ sự quan tâm hay tìm hiểu thêm về dự án của bạn ở đâu? (Xem danh sách ý tưởng dự án để biết ví dụ.)
- Công bố trang đề xuất của bạn trong các kênh cộng đồng và thêm tổ chức của bạn vào danh sách các tổ chức quan tâm trong Kho lưu trữ phần tài liệu GitHub. Bạn cũng nên chia sẻ đường liên kết của mình trong kênh #season-of-docs trong Tài liệu Slack. Trang quảng cáo và báo chí bao gồm biểu trưng và nội dung khác mà bạn có thể sử dụng khi nói về Phần Tài liệu.
- Đối với mỗi ý tưởng về tài liệu, hãy cân nhắc những kinh nghiệm và trình độ cần thiết mà một người viết nội dung kỹ thuật cần có để làm việc hiệu quả với cộng đồng và tổ chức của bạn. Những kỹ năng nào mà cộng đồng của bạn có thể giúp người viết nội dung kỹ thuật phát triển (ví dụ: sử dụng GitHub hoặc chuỗi công cụ tài liệu)? (Xem hướng dẫn hợp tác với người viết nội dung kỹ thuật.
- Hãy nhờ các tình nguyện viên giúp trả lời câu hỏi của những người viết nội dung kỹ thuật quan tâm.
- Bắt đầu xem xét mọi tuyên bố về mối quan tâm mà người viết nội dung kỹ thuật muốn hợp tác với dự án của bạn đã gửi.
Giai đoạn đăng ký
- Chọn ý tưởng hứa hẹn nhất từ trang đề xuất của bạn. Mỗi tổ chức chỉ có thể gửi một đề xuất. Một số điều cần lưu ý:
- Ý tưởng nào nhận được nhiều sự quan tâm nhất của các tác giả viết nội dung kỹ thuật?
- Ý tưởng nào sẽ giúp bạn giải quyết vấn đề lớn nhất của dự án? Bạn nên chọn một ý tưởng rủi ro hơn sẽ có tác động lớn hơn ý tưởng cho một dự án tài liệu có nhiều khả năng hoàn thành hơn nhưng sẽ không tạo ra sự khác biệt đáng kể cho dự án của bạn.
- Ý tưởng có đòi hỏi sự tham gia của các thành viên cụ thể trong cộng đồng của bạn không? Họ có thời gian tham gia không?
Tạo đề xuất của bạn, sử dụng mẫu đề xuất. Hãy đảm bảo bạn hiểu và cung cấp những thông tin sau:
- Vấn đề bạn muốn giải quyết
- Phạm vi của tài liệu mà bạn muốn cải thiện hoặc tạo
- Cách bạn đo lường mức độ thành công của tài liệu
Đề xuất của bạn cũng phải bao gồm ngân sách. Đề xuất chưa hoàn chỉnh sẽ không được xem xét.
Gửi Biểu mẫu đăng ký trước hạn chót đăng ký ngày 26 tháng 3 năm 2021 lúc 18:00 giờ UTC. Những đề xuất được chấp nhận sẽ được công bố vào ngày 16 tháng 4 năm 2021.
Phát triển và báo cáo dự án
Khởi động dự án
- Nếu tổ chức của bạn đã chọn người viết nội dung kỹ thuật hoặc người viết nội dung kỹ thuật cho dự án, hãy có cuộc họp khởi động với người viết nội dung kỹ thuật. Bạn nên cộng tác với người viết nội dung kỹ thuật để tạo lịch biểu cho công việc và những lần kiểm tra thường xuyên.
- Nếu bạn nhận được nhiều lời tuyên bố về mối quan tâm của các tác giả có quan tâm về kỹ thuật, hãy thông báo công khai về lựa chọn nhà biên kịch kỹ thuật của bạn hoặc thông báo cho người đăng ký về quyết định của bạn.
Cấp khoản thanh toán
- Mùa Tài liệu sẽ gửi 40% quỹ tài trợ vào tài khoản Open Collective của mỗi tổ chức sau khi họ thuê người viết nội dung kỹ thuật, kể từ ngày 10 tháng 6 năm 2021. 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ả việc thanh toán khi bắt đầu dự án.
- 60% còn lại sẽ được chuyển vào tài khoản Open Collective của những tổ chức hoàn thành và gửi bài đánh giá cũng như nghiên cứu điển hình sau cùng, kể từ ngày 14 tháng 12 năm 2021.
- Hãy xem hướng dẫn về quy trình thanh toán để biết thêm thông tin về cách tạo tài khoản Open Collective.
Báo cáo trạng thái dự án
- Quản trị viên tổ chức cần điền vào báo cáo trạng thái hằng tháng trong vòng một tuần kể từ khi nhận được đường liên kết đến biểu mẫu báo cáo trạng thái (đường liên kết sẽ được gửi qua email, vì vậy, vui lòng kiểm tra thư mục thư rác).
Đánh giá hoàn thiện dự án và nghiên cứu điển hình
Các tổ chức phải hoàn tất và gửi cả kết quả đánh giá cuối cùng của dự án và nghiên cứu điển hình trước 18:00 (giờ UTC) ngày 30 tháng 11 năm 2021 để nhận được kinh phí tài trợ còn lại.
Đánh giá cuối cùng
Biểu mẫu đánh giá cuối cùng sẽ được cung cấp cho quản trị viên tổ chức vào lúc 18:00 ngày 30 tháng 11 năm 2021 (giờ UTC).
Nghiên cứu điển hình
Nghiên cứu điển hình về Mùa Tài liệu là sản phẩm quan trọng để tổ chức của bạn tham gia Chương trình Tài liệu năm 2021. Việc lưu nhật ký cập nhật dự án hằng tuần sẽ giúp bạn tạo nghiên cứu điển hình của mình. Mỗi tuần, hãy ghi lại tiến trình dự án (bao gồm cả các đường liên kết đến yêu cầu lấy dữ liệu, vấn đề hoặc cuộc trò chuyện, nếu hữu ích), những gì tốt (hoặc không tốt), những điều bạn đã học được và câu hỏi được đặt ra.
Vui lòng đọc bài viết tạo nghiên cứu điển hình để biết thêm thông tin và nhớ làm theo mẫu nghiên cứu điển hình của chúng tôi để tạo nghiên cứu điển hình của bạn. Bạn sẽ gửi nghiên cứu điển hình của mình dưới dạng một đường liên kết trong biểu mẫu đánh giá cuối cùng.
Nghiên cứu điển hình của bạn sẽ được xuất bản trên trang web Phần tài liệu, vì vậy, hãy lưu ý điều đó khi cung cấp thông tin về dự án của bạn.
Chúng tôi yêu cầu các tổ chức tham gia ít nhất 3 bài khảo sát tiếp theo để giúp chúng tôi theo dõi mức độ thành công của các dự án Phần tài liệu theo thời gian.
Biểu mẫu
| Biểu mẫu | Đường liên kết | Hạn chót |
|---|---|---|
| Đơn đăng ký của tổ chức | Đơn đăng ký của tổ chức hiện đã đóng. Tham gia danh sách gửi thư thông báo tại season-of-docs-announce để luôn nắm bắt thông tin. |
18:00, ngày 26 tháng 3 năm 2021 (giờ UTC) |
| Thông tin thanh toán của tổ chức | Giai đoạn thông tin thanh toán của tổ chức đã hoàn tất. Nếu bạn cần thay đổi thông tin thanh toán của tổ chức của mình, vui lòng liên hệ với quản trị viên của phần Tài liệu. |
18:00, ngày 12 tháng 5 năm 2021 (giờ UTC) |
| Bằng chứng về việc thuê biên tập viên kỹ thuật | Hoàn tất giai đoạn tuyển dụng nhân viên kỹ thuật. |
18:00, ngày 17 tháng 5 năm 2021 (giờ UTC) |
| Đánh giá hằng tháng | Xem dòng thời gian | |
| Đánh giá dự án cuối cùng và nghiên cứu điển hình | Biểu mẫu được cung cấp trong giai đoạn đánh giá dự án hoàn thiện và giai đoạn nghiên cứu điển hình (22/11/2024 – 10/12/2024). |
18:00, ngày 30 tháng 11 năm 2021 (giờ UTC) |
| Khảo sát tiếp theo | Biểu mẫu được cung cấp trong giai đoạn khảo sát tiếp theo (ngày 1 tháng 5 năm 2025). |
Xem dòng thời gian |
Thông tin liên quan
- Xem lại Dòng thời gian của Phần Tài liệu.