Giai đoạn hiện tại:
Kết quả đã công bố
tiến trình.
Hướng dẫn này dành cho các quản trị viên tổ chức đăng ký hoặc tham gia chương trình Phần tài liệu.
Tổ chức của bạn có nên tham gia chương trình Phần tài liệu không?
Sử dụng các câu hỏi này để giúp bạn biết liệu tổ chức hoặc dự án nguồn mở 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 tin rằng tài liệu mới hoặc tài liệu được cập nhật sẽ giúp bạn đạt được mục tiêu hoặc giải quyết vấn đề trong dự án hoặc cộng đồng của mình?
- Bạn có hiểu biết ban đầu hoặc có giả thuyết về cách đo lường mức độ thành công của dự án tài liệu không?
- Các thành viên trong cộng đồng có sẵn sàng giúp tuyển dụng, đánh giá và đào tạo một người viết kỹ thuật và ai có thể trả lời câu hỏi cũng như hỗ trợ khác trong suốt dự án (6-8 tháng, kể cả thời gian đăng ký)?
- Bạn có sẵn sàng làm việc với một thành viên trong cộng đồng với tư cách là quản trị viên của tổ chức và phối hợp tạo đơn đăng ký, trả lời câu hỏi của quản trị viên chương trình, cũng như gửi kết quả đánh giá hằng tháng cũng như kết quả đá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 sàng trả lời các bản khảo sát tiếp theo sau khi hoàn tất chương trình Phần tài liệu.
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 được 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ù chúng tôi sẽ mở đơn đăng ký Phần Tài liệu từ ngày 23 tháng 2 năm 2022, 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 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 khả thi và chỉ số khả thi. Trang này sẽ ở 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 những 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 hoặc tìm hiểu thêm về dự án của bạn ở đâu? Bạn nên thêm địa chỉ email để liên hệ với tổ chức nguồn mở của mình về Phần Tài liệu. Tuy nhiên, bạn không nên sử dụng địa chỉ email cá nhân làm địa chỉ email để liên hệ với tổ chức nguồn mở của mình. (Xem danh sách ý tưởng dự án để biết ví dụ.)
- Công bố trang đề xuất của bạn trên 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 trên GitHub. Bạn cũng có thể chia sẻ đường liên kết của mình trên kênh #season-of-docs trong mục Write The 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à năng lực mà một người viết nội dung kỹ thuật cần có để có thể làm việc thành công với cộng đồng và tổ chức của bạn. Cộng đồng của bạn có thể giúp người viết kỹ thuật phát triển những kỹ năng nào (ví dụ: sử dụng GitHub hoặc chuỗi công cụ tài liệu của bạn)? (Xem hướng dẫn làm việ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 về kỹ thuật quan tâm.
- Bắt đầu xem xét mọi tuyên bố về sự quan tâm đã gửi của những người viết nội dung kỹ thuật quan tâm đến việc làm việc với dự án của bạn.
Giai đoạn đăng ký
- Chọn ý tưởng triển vọng 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ả về kỹ thuật?
- Ý tưởng nào sẽ giúp giải quyết vấn đề lớn nhất của dự án của bạ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 so với một ý 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ó yêu cầu sự tham gia của những 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 rõ 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. Những đề xuất chưa hoàn chỉnh sẽ không được xem xét.
Vui lòng gửi đơn đăng ký đến hết hạn chót đăng ký là 18:00 ngày 25 tháng 3 năm 2022 (giờ UTC). Các đề xuất được chấp nhận sẽ được công bố vào ngày 14 tháng 4 năm 2022.
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 một người viết nội dung kỹ thuật hoặc người viết nội dung cho dự án của bạn, hãy có một cuộc họp mở đầu 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 để lên lịch làm việc và những buổi kiểm tra thường xuyên.
- Nếu bạn nhận được nhiều lời tuyên bố về sự quan tâm của các cây bút kỹ thuật mà bạn quan tâm, hãy thông báo công khai về lựa chọn tác giả kỹ thuật của bạn hoặc thông báo quyết định của bạn cho người đăng ký.
Cấp khoản thanh toán
- Kể từ ngày 9 tháng 6 năm 2022, phần Tài liệu sẽ chuyển 40% quỹ tài trợ vào tài khoản Open Collective của mỗi tổ chức sau khi họ thuê một người viết nội dung kỹ thuật. 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.
- Kể từ ngày 14 tháng 12 năm 2022, 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 kết quả đánh giá cuối cùng cũng như nghiên cứu điển hình của họ. Xin lưu ý rằng tất cả dự án thành công, bất kể tiến trình hoàn thành dự án (ví dụ: dự án 3 tháng so với 6 tháng), sẽ bắt đầu nhận được khoản thanh toán cuối cùng vào ngày 14 tháng 12 năm 2022
- 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á lần cuối của dự án và nghiên cứu điển hình
Các tổ chức phải hoàn thành và gửi cả kết quả đánh giá cuối cùng của dự án lẫn nghiên cứu điển hình trước 18:00 (giờ UTC) ngày 30 tháng 11 năm 2022 để nhận số tiền 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 giờ (giờ UTC) trước ngày 30 tháng 11 năm 2022 ít nhất một tháng.
Nghiên cứu điển hình
Nghiên cứu điển hình về Phần Tài liệu là tài liệu chính giúp tổ chức của bạn tham gia vào Phần Tài liệu. Việc lưu nhật ký hằng tuần về thông tin cập nhật dự án sẽ giúp bạn tạo nghiên cứu điển hình của mình. Đối với mỗi tuần, hãy ghi lại tiến trình dự án (bao gồm các đường liên kết đến yêu cầu, vấn đề hoặc cuộc trò chuyện, nếu hữu ích), những gì hoạt động 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à hãy 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 Season of Tài liệu, vì vậy, hãy lưu ý điều này 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 Season of 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 | Ứng dụng của tổ chức hiện đã bị đó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 (giờ UTC) ngày 25 tháng 3 năm 2022 |
| Thông tin thanh toán của tổ chức | Biểu mẫu này chưa có sẵn. |
18:00 ngày 12 tháng 5 năm 2022 (giờ UTC) |
| Bằng chứng về việc thuê người viết nội dung kỹ thuật | Hoàn tất giai đoạn tuyển dụng biên tập viên kỹ thuật. |
18:00 ngày 16 tháng 5 năm 2022 (giờ UTC) |
| Đánh giá hằng tháng | Giai đoạn đánh giá hằng tháng đã kết thúc. |
Xem dòng thời gian |
| Đánh giá dự án cuối cùng và nghiên cứu điển hình | Giai đoạn đánh giá dự án đã kết thúc. |
18:00 ngày 30 tháng 11 năm 2022 (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 2 tháng 5 năm 2023). |
Xem dòng thời gian |
Thông tin liên quan
- Xem lại Dòng thời gian phần Tài liệu.