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

Giai đoạn hiện tại:
Phát triển tài liệu. Xem tiến trình.

Hướng dẫn này dành cho các nhà văn 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 Google Season of Docs.

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

Hãy dùng những câu hỏi này để giúp bạn biết liệu bạn có muốn hợp tác với một tổ chức được chấp nhận trong chương trình Google Season of Docs hay không.

  • Bạn có kỹ năng và kinh nghiệm viết tài liệu kỹ thuật không? Google Season of Docs không nhằm mục đích hướng dẫn các kỹ năng viết kỹ thuật cơ bản. Bạn có tự động viên và có tổ chức không?
  • Bạn có thời gian tham gia trong 6 tháng diễn ra chương trình không? Quy mô dự án khác nhau, nhưng dao động 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 lòng dành thời gian tìm hiểu quy trình của dự án và các quy tắc của cộng đồng không?
  • Bạn có sẵn sàng làm việc với quản trị viên tổ chức để tinh chỉnh đề xuất dự án, phát triển tiến trình, đánh giá và biên soạn các chỉ số, đồng thời giúp toàn bộ tổ chức hiểu được giá trị của việc viết tài liệu kỹ thuật không?

Bạn cũng phải đáp ứng các yêu cầu về điều kiện tham gia chương trình, bao gồm cả việc có thể tạo tài khoản Open Collective. Bạn phải có đủ điều kiện hợp pháp để nhận tiền 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 của chương trình Google Season of Docs không thể tư vấn thuế hoặc trả lời các câu hỏi về việc bạn có đủ điều kiện làm việc hay không.

Là một nhà văn kỹ thuật có tay nghề tham gia Chương trình Google Season of Docs, bạn sẽ được trả tiền để có được kinh nghiệm làm việc trong nguồn mở, đồng thời 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 Google Season of Docs với vai trò là nhà văn kỹ thuật

Giai đoạn khám phá

Thời hạn đăng ký đối với tổ chức là 18:00 (giờ UTC) ngày 2 tháng 4 năm 2024. Bạn nên bắt đầu tìm hiểu các dự án có thể có càng sớm càng tốt. Tuy nhiên, các tổ chức có thể chọn cộng tác với các nhà văn kỹ thuật bất cứ lúc nào trước 18:00 (giờ UTC) ngày 22 tháng 5 năm 2024.

  • Tìm dự án mà bạn quan tâm
    • Hãy liên hệ trực tiếp với các tổ chức nguồn mở theo hướng dẫn trên trang chương trình Google Season of Docs của họ hoặc tham khảo kho lưu trữ GitHub của Google Season of Docs để tìm những tổ chức đã bày tỏ sự quan tâm đến việc tham gia Google Season of Docs. Bạn cũng có thể tìm thấy các tổ chức quan tâm tại kênh #season-of-docs trong phần Viết Slack cho Tài liệu.
    • Một số cách chọn dự án:
      • Chọn một dự án bằng ngôn ngữ mà 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 một 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.
      • Hãy chọn một dự án dựa trên mức độ thân thiện của cộng đồng! Tham gia các diễn đàn thảo luận, tham khảo tài khoản mạng xã hội của các cộng tác viên (nếu họ nói về dự án của họ) và xem tài liệu hướng dẫn làm quen của họ (nếu có).
      • Nếu bạn muốn hợp tác với một dự án không có trong danh sách dự án, hãy liên hệ với dự án đó và đề nghị họ cân nhắc đăng ký!
  • Xem các trang đề xuất của dự án
    • Sau khi bạn có 3 đến 5 dự án tiềm năng, hãy xem trang đề xuất của từng dự án
    • Bạn nên đặt câu hỏi, đưa ra ý kiến phản hồi và đề xuất thông qua các kênh mà dự án đã liệt kê để phản hồi và thảo luận
  • Gửi tuyên bố quan tâm trực tiếp đến tổ chức. Trong tuyên bố quan tâm, bạn sẽ cho thấy cách bạn sẽ đạt được các mục tiêu được nêu trong đề xuất dự án của tổ chức.
    • Sử dụng mẫu tuyên bố quan tâm của Google Season of Docs. 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ố về mong muốn 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 đảm bảo bạn chứng minh rằng bạn đáp ứng những yêu cầu đó trong bảng sao kê.
    • 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 Google Season of Docs.

Giai đoạn ứng dụng

  • Hãy chờ thông báo về các tổ chức được chấp nhận thông qua Phần Tài liệu của Google:
    • Những tổ chức được chấp nhận sẽ liên hệ trực tiếp nếu họ muốn hợp tác với bạn hoặc thảo luận thêm về tuyên bố quan tâm của bạn.
    • Các tổ chức không chỉ được làm việc với những nhà văn 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ể mời gọi thêm tuyên bố về lợi ích sau khi chấp nhận thoả thuận. Các tổ chức phải chọn một người viết nội dung kỹ thuật trước 18:00 (giờ UTC) ngày 22 tháng 5 năm 2024.
    • 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ố quan tâm không thành công.

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

  • Làm việc với tổ chức để tạo lịch trình, 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 lần đánh giá cuối cùng và nghiên cứu điển hình.