Hướng dẫn cho người viết kỹ thuật

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 người viết kỹ thuật muốn làm việc với các tổ chức được chấp nhận trong chương trình Phần tài liệu.

Bạn có nên tham gia chương trình Phần Tài liệu không?

Sử dụng những câu hỏi sau để giúp bạn biết liệu bạn có muốn làm việc với một tổ chức được chấp nhận trong chương trình Phần Tài liệu hay không.

  • Bạn có kỹ năng và kinh nghiệm viết nội dung kỹ thuật không? Phần Tài liệu không nhằm dạy các kỹ năng viết kỹ thuật cơ bản. Bạn có khả năng tự tạo động lực và có tổ chức không?
  • Bạn có thời gian để tham gia trong suốt 6 tháng của chương trình này không? Quy mô dự án đa dạng, nhưng cam kết từ 5 đến 30 giờ mỗi tuần trong suốt chương trình.
  • Bạn có muốn tích luỹ kinh nghiệm làm việc trong lĩnh vực nguồn mở không? Bạn có sẵn sàng dành thời gian để tìm hiểu các quy trình và chuẩn mực cộng đồng của một dự án không?
  • Bạn có sẵn sàng làm việc với quản trị viên của tổ chức để tinh chỉnh đề xuất dự án, xây dựng lịch trình, đánh giá và biên soạn các chỉ số, đồng thời giúp cả tổ chức hiểu được giá trị của việc viết kỹ thuật không?

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. Xin lưu ý rằng bạn có thể nhận tiền hợp pháp cho các công việc được thực hiện tại nơi cư trú của mình. Quản trị viên chương trình Season of Tài liệu không thể tư vấn về thuế hoặc trả lời câu hỏi về điều kiện sử dụng công việc của bạn.

Là một người viết kỹ thuật có kỹ năng tham gia Phần Tài liệu, bạn sẽ được trả tiền để có kinh nghiệm làm việc trong nguồn mở trong khi bạn giúp dự án của mình giải quyết một nhu cầu chính thông qua tài liệu tốt hơn.

Tham gia chương trình Phần Tài liệu với vai trò là người viết nội dung kỹ thuật

Giai đoạn khám phá

Hạn chót đăng ký là 18:00 ngày 25 tháng 3 năm 2022 (giờ UTC). Người viết nội dung kỹ thuật nên bắt đầu tìm hiểu các dự án khả thi càng sớm càng tốt. Tuy nhiên, các tổ chức có thể chọn nhà xuất bản kỹ thuật để hợp tác bất cứ lúc nào trước 18:00 (giờ UTC) ngày 16 tháng 5 năm 2022.

  • Tìm dự án mà bạn quan tâm
    • Liên hệ trực tiếp với các tổ chức nguồn mở bằng cách sử dụng hướng dẫn trên trang chương trình Phần Tài liệu của họ hoặc xem Kho lưu trữ Phần Tài liệu trên GitHub để tìm các tổ chức đã bày tỏ sự quan tâm đến việc tham gia Phần Tài liệu. Bạn cũng có thể tìm thấy các tổ chức quan tâm trong kênh #season-of-docs trong mục Viết Slack tài liệu.
    • Một số cách chọn dự án:
      • Chọn một dự án bằng ngôn ngữ bạn quen thuộc hoặc quan tâm, chẳng hạn như JavaScript hoặc C.
      • Chọn một dự án trong lĩnh vực công nghệ hoặc lĩnh vực mà bạn quan tâm, chẳng hạn như học máy, khoa học mở hoặc robot.
      • Chọn dự án dựa trên mức độ phù hợp của cộng đồng! Tham gia các diễn đàn thảo luận của họ, xem tài khoản mạng xã hội của người đóng góp (nếu họ nói về dự án của mình ở đó) và xem tài liệu làm quen với sản phẩm (nếu có).
      • Nếu bạn muốn hợp tác với một dự án nhưng dự án đó chưa có trong danh sách dự án, hãy liên hệ với dự án đó và đề nghị họ xem xét đăng ký!
  • Xem lại các trang đề xuất của dự án
    • Khi bạn có thể có từ 3 đến 5 dự án, hãy xem trang đề xuất của mỗi dự án
    • Bạn nên đặt câu hỏi, đưa ra phản hồi và đề xuất bằng cách sử dụng các kênh mà dự án đã liệt kê để nhận ý kiến phản hồi và thảo luận
  • Gửi tuyên bố quan tâm trực tiếp cho tổ chức. Trong tuyên bố quan tâm, bạn sẽ cho biết cách bạn sẽ đạt được những mục tiêu đã đặt ra trong đề xuất dự án của tổ chức.
    • Sử dụng mẫu tuyên bố mối quan tâm của Phần Tài liệu. Càng ngắn càng tốt!
    • Hãy làm theo hướng dẫn trên trang ý tưởng của tổ chức để gửi tuyên bố quan tâm của bạn. Nếu tổ chức đã đưa ra bất kỳ yêu cầu đặc biệt nào, hãy nhớ chứng minh rằng bạn đáp ứng các yêu cầu đó trong bảng tuyên bố.
    • Bằng việc gửi tuyên bố quan tâm, bạn đồng ý tuân thủ quy tắc ứng xử của tổ chức và quy tắc ứng xử của Phần Tài liệu.

Giai đoạn đăng ký

  • Chờ thông báo về các tổ chức được chấp nhận theo Phần Tài liệu:
    • Các tổ chức được chấp nhận sẽ liên hệ trực tiếp nếu họ muốn làm việc với bạn hoặc thảo luận thêm về tuyên bố mối quan tâm của bạn.
    • Các tổ chức không bị giới hạn ở việc chỉ làm việc với những người viết nội dung kỹ thuật đã gửi tuyên bố quan tâm trước thời hạn đăng ký của tổ chức. Họ có thể thu thập thêm các tuyên bố về mối quan tâm sau khi chấp nhận thoả thuận. Các tổ chức phải chọn người viết nội dung kỹ thuật trước 18:00 ngày 16 tháng 5 năm 2022 (giờ UTC).
    • Các tổ chức không bắt buộc phải đưa ra ý kiến phản hồi về những tuyên bố mối quan tâm không được hỗ trợ.

Giai đoạn phát triển dự án

  • Làm việc với tổ chức để tạo lịch biểu, bao gồm cả các sản phẩm và thời hạn.

Giai đoạn đánh giá cuối cùng và nghiên cứu điển hình

  • Làm việc với tổ chức để cung cấp thông tin cần thiết cho quá trình đánh giá cuối cùng và nghiên cứu điển hình.