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

Giai đoạn hiện tại:
Chương trình Phần Tài liệu năm 2019 đã kết thúc vào ngày 6 tháng 3 năm 2020. Hãy xem dòng thời gian.

Trang này chứa hướng dẫn dành cho người viết kỹ thuật tham gia Phần Tài liệu.

Giới thiệu

Chào mừng bạn đến với Phần Tài liệu! Hướng dẫn này sẽ cho bạn biết đôi điều về việc bạn tham gia Phần Tài liệu và giúp bạn về những hoạt động nên thực hiện trong mỗi giai đoạn của chương trình.

Điều kiện tham gia Phần Tài liệu

Để tham gia Phần Tài liệu với tư cách là người viết nội dung kỹ thuật, bạn phải:

  • Đủ 18 tuổi tại thời điểm đăng ký.
  • Có thể thể hiện kinh nghiệm viết kỹ thuật trước đây bằng cách gửi nội dung mô tả vai trò và mẫu công việc.
  • Đủ điều kiện làm việc tại quốc gia cư trú của họ trong thời gian tham gia chương trình.
  • Cư dân của một quốc gia hiện không bị Hoa Kỳ cấm vận. Xem Chương trình cấm vận và thông tin quốc gia của Kho bạc Hoa Kỳ.

Xem toàn bộ điều khoản dành cho chuyên viên kỹ thuật.

Người cố vấn nguồn mở của bạn

Người cố vấn Mùa trong Tài liệu không nhất thiết là người viết kỹ thuật và họ có thể có ít kinh nghiệm giao tiếp kỹ thuật. Họ là thành viên của tổ chức nguồn mở, họ hiểu rõ giá trị của việc sở hữu tài liệu chất lượng cao và có kinh nghiệm về các công cụ và quy trình nguồn mở.

Mối quan hệ giữa bạn và người cố vấn là sự cộng tác. Bạn mang lại cho tổ chức nguồn mở kinh nghiệm và kỹ năng về tài liệu. Người cố vấn của bạn sẽ đóng góp kiến thức về nguồn mở và mã nguồn mở. Bạn có thể cùng nhau phát triển tài liệu kỹ thuật và cải thiện các quy trình của dự án nguồn mở.

Các giai đoạn thông báo về chương trình và đăng ký trong tổ chức

Ngày thông báo về Phần Tài liệu là ngày 11 tháng 3 năm 2019. Các tổ chức nguồn mở quan tâm đến tính năng này có thể đăng ký tham gia Phần Tài liệu từ ngày 2 tháng 4 năm 2019 đến ngày 23 tháng 4 năm 2019. Các quản trị viên chương trình của Google sẽ công bố danh sách các tổ chức thành công vào ngày 30 tháng 4 năm 2019.

Trong khoảng thời gian từ khi thông báo chương trình đến thời điểm xuất bản của các tổ chức nguồn mở tham gia, bạn nên theo dõi tin tức. Bạn có thể quay lại trang web này và xem các bài đăng trên blog hoặc tin tức khác trên web. Một số tổ chức nguồn mở có thể chia sẻ ý tưởng của họ ngay cả trong giai đoạn đăng ký của tổ chức.

Chúng tôi cũng mời bạn giới thiệu về Phần Tài liệu và lý do bạn quan tâm đến chương trình này. Hãy xem tài liệu quảng cáo cho đồ hoạ và ý tưởng.

Giai đoạn khám phá tác giả kỹ thuật

Giai đoạn khám phá tác giả kỹ thuật sẽ bắt đầu từ ngày 30 tháng 4 đến ngày 28 tháng 5 năm 2019. Trong khoảng thời gian này, bạn có thể khám phá danh sách các tổ chức tham gia và ý tưởng dự án của họ.

Khi tìm thấy một hoặc nhiều dự án mà bạn quan tâm, bạn nên trực tiếp liên hệ với tổ chức nguồn mở có liên quan để thảo luận về các ý tưởng dự án.

Nhiệm vụ của bạn với vai trò là người viết kỹ thuật trong giai đoạn này

Hãy khám phá danh sách các tổ chức nguồn mở tham gia và ý tưởng dự án của họ.

Kiểm tra danh sách để tìm tổ chức nguồn mở mà bạn muốn hợp tác. Hãy xem các dự án viết kỹ thuật mà các tổ chức đề xuất rồi quyết định dự án nào phù hợp với bạn. Bạn có thể đăng ký cho nhiều tổ chức. Ở giai đoạn này của Phần Tài liệu, bạn nên khám phá nhiều lựa chọn. Quy trình lựa chọn cuối cùng chỉ chấp nhận một dự án cho mỗi người viết kỹ thuật.

Tổ chức nguồn mở tham gia chương trình

Thảo luận ý tưởng dự án với các tổ chức nguồn mở.

Bạn có thể thảo luận các ý tưởng dự án với bất kỳ tổ chức nào tham gia. Để liên hệ, hãy sử dụng địa chỉ email của tổ chức có trong danh sách các tổ chức tham gia. Các cuộc thảo luận sớm giúp bạn tập hợp một đề xuất dự án phù hợp để gửi cho quản trị viên chương trình của Google trong giai đoạn đăng ký kỹ thuật của nhà viết. Các ý tưởng dự án ban đầu có thể lấy từ danh sách ý tưởng mà tổ chức đã đề xuất. Bạn cũng có thể đề xuất ý tưởng của riêng mình.

Tổ chức nguồn mở tham gia chương trình

Ý tưởng cho dự án viết kỹ thuật

Giai đoạn đăng ký của người viết kỹ thuật

Giai đoạn đăng ký của tác giả kỹ thuật bắt đầu từ ngày 29 tháng 5 năm 2019 đến ngày 28 tháng 6 năm 2019. Trong khoảng thời gian này, bạn có thể đăng ký dùng Phần Tài liệu. Quản trị viên chương trình của Google sẽ chuyển tiếp thông tin chi tiết có liên quan từ ứng dụng của bạn đến tổ chức nguồn mở mà bạn đã chọn. Sau đó, quản trị viên và người cố vấn của tổ chức nguồn mở sẽ chọn dự án mà họ muốn cố vấn.

Nhiệm vụ của bạn với tư cách là ứng viên viết nội dung kỹ thuật trong giai đoạn này

Hãy gửi đơn đăng ký của bạn để tham gia Phần Tài liệu.

Hãy gửi đơn đăng ký tham gia Phần Tài liệu trước ngày 28 tháng 6 năm 2019.

Tạo ứng dụng

Đơn đăng ký dành cho người viết kỹ thuật trong Tài liệu năm 2019 hiện đã đóng.

Giai đoạn gắn kết cộng đồng

Giai đoạn gắn kết cộng đồng diễn ra từ ngày 7/8 đến ngày 1/9/2019. Trong giai đoạn này, các cố vấn nguồn mở sẽ giúp bạn làm quen với cộng đồng và dự án nguồn mở.

Nhiệm vụ của bạn với vai trò là người viết kỹ thuật trong giai đoạn này

Thiết lập kênh liên lạc.

Liên hệ với(những) người cố vấn trong tổ chức nguồn mở mà bạn đã chọn hợp tác. Đảm bảo rằng bạn có cách thức đáng tin cậy để liên lạc trực tiếp với người cố vấn và với quản trị viên của tổ chức – người sau này là thành viên của tổ chức nguồn mở và đóng vai trò là người liên hệ chính trong Phần Tài liệu cho tổ chức của họ.

Trách nhiệm của bạn

Trách nhiệm của người cố vấn

Hướng dẫn của cố vấn về cách làm việc với người viết nội dung kỹ thuật

Tham gia vào dự án nguồn mở và cộng đồng nguồn mở.

Đặt câu hỏi cho người cố vấn về những công cụ và quy trình mà tổ chức nguồn mở sử dụng. Hãy giới thiệu bản thân về danh sách gửi thư, cuộc trò chuyện, kênh Slack và bất kỳ kênh liên lạc dùng chung nào khác của cộng đồng nguồn mở.

Nắm được tổng thể sản phẩm.

Yêu cầu người cố vấn giải thích về sản phẩm (đặc biệt là về mặt lý thuyết) mà bạn sắp soạn thảo. Thảo luận chi tiết về đối tượng của tài liệu.

Đặt mục tiêu và kỳ vọng.

Hãy làm việc với người cố vấn để tinh chỉnh mục tiêu cho dự án viết kỹ thuật của bạn và đặt ra kỳ vọng cho cả hai phía. Việc đặt ra những mục tiêu và kỳ vọng này giờ đây là một cách hữu ích để đảm bảo thành công cho dự án của bạn.

Giai đoạn phát triển tài liệu

Giai đoạn phát triển tài liệu từ ngày 02/9/2019 đến ngày 22/11/2019. (Ngày kết thúc sẽ khác đối với các dự án chạy trong thời gian dài.) Trong thời gian này, bạn làm việc trên dự án của mình dưới sự tư vấn chặt chẽ của những người cố vấn.

Nhiệm vụ của bạn với vai trò là người viết kỹ thuật trong giai đoạn này

Làm việc với người cố vấn để hoàn thành dự án của bạn.

Hãy phối hợp chặt chẽ với người cố vấn để hoàn thành dự án của bạn. Hãy làm theo quy trình của cộng đồng nguồn mở để yêu cầu xem xét tài liệu thu được và gửi nội dung cập nhật đến kho lưu trữ nguồn mở. Ví dụ: các dự án nguồn mở được lưu trữ trên GitHub sẽ thêm hoặc cập nhật tệp bằng cách tạo yêu cầu kéo để xem xét và gửi.

Trình bày mọi mối lo ngại với quản trị viên của tổ chức.

Nếu bạn có thắc mắc về việc giao tiếp với người cố vấn hoặc gặp bất kỳ vấn đề nào khác có thể ảnh hưởng đến việc hoàn thành dự án thành công, hãy thông báo cho quản trị viên của tổ chức sử dụng nguồn mở.

Trách nhiệm của bạn

Hoàn thành bài khảo sát bất kỳ từ các quản trị viên chương trình Google.

Quản trị viên chương trình của Google có thể gửi bản khảo sát giữa dự án để đánh giá tiến độ. Hoàn thành bài khảo sát và gửi câu trả lời của bạn cho quản trị viên chương trình Google theo hướng dẫn trên tài liệu khảo sát.

Giai đoạn quyết định và đánh giá dự án

Giai đoạn hoàn thiện dự án bắt đầu từ ngày 25 đến ngày 29 tháng 11 năm 2019 và giai đoạn đánh giá sẽ bắt đầu từ ngày 25 tháng 11 đến ngày 6 tháng 12 năm 2019. (Ngày khác đối với các dự án chạy trong thời gian dài.) Trong giai đoạn hoàn thiện dự án, bạn sẽ gửi báo cáo dự án, còn gọi là báo cáo sản phẩm hoàn thiện. Trong giai đoạn đánh giá, bạn gửi đánh giá về(các) người cố vấn và trải nghiệm của bạn với tư cách là người tham gia Phần Tài liệu.

Nhiệm vụ của bạn với vai trò là người viết kỹ thuật trong giai đoạn này

Viết báo cáo dự án.

Viết báo cáo dự án (đôi khi gọi là sản phẩm công việc). Báo cáo dự án bao gồm thông tin mô tả về những việc bạn đã làm trong Phần Tài liệu và mọi đường liên kết có liên quan.

Tạo báo cáo dự án

Đã kết thúc giai đoạn hoàn thiện dự án Season of Tài liệu năm 2019.

Yêu cầu người cố vấn xem xét báo cáo dự án của bạn.

Người cố vấn của bạn có thể có những thông tin chi tiết hữu ích về cách mô tả thành tích của bạn. Ngoài ra, ở giai đoạn này, việc nắm được thông tin chung về trạng thái của dự án sẽ giúp ích cho bạn, trước khi người cố vấn đánh dấu dự án là đã hoàn tất thành công hay chưa.

Hoàn tất báo cáo dự án.

Hãy hoàn tất báo cáo dự án của bạn chậm nhất vào 18:00 ngày 28 tháng 2 năm 2020 (giờ UTC). Bạn có thể chỉnh sửa biểu mẫu này, nhưng phải gửi phiên bản hoàn thiện muộn nhất vào ngày cụ thể.

Đã kết thúc giai đoạn hoàn thiện dự án Season of Tài liệu năm 2019.

Viết và gửi đánh giá về người cố vấn cũng như trải nghiệm của bạn về Phần Tài liệu.

Hãy hoàn thành và gửi bài đánh giá của bạn chậm nhất vào 18:00 (giờ UTC) ngày 28 tháng 2 năm 2020.

Đánh giá của người viết kỹ thuật

Trách nhiệm của bạn

Đã kết thúc giai đoạn hoàn thiện dự án Season of Tài liệu năm 2019.

Dự án chạy trong thời gian dài

Đối với các dự án viết kỹ thuật có độ dài tiêu chuẩn trong phần Tài liệu, giai đoạn phát triển tài liệu sẽ bắt đầu từ ngày 2 tháng 9 năm 2019 đến ngày 22 tháng 11 năm 2019. Tuy nhiên, một số người viết nội dung kỹ thuật có thể đăng ký tham gia một dự án lâu dài dưới sự tư vấn của tổ chức nguồn mở. Đối với một dự án dài hạn, giai đoạn phát triển tài liệu sẽ kéo dài từ ngày 2/9/2019 đến ngày 21/2/2020.

Thời gian hoàn tất và đánh giá dự án đối với các dự án dài hạn là từ ngày 24 đến ngày 28 tháng 2 năm 2020.

Các nhiệm vụ và trách nhiệm của bạn cũng giống như được mô tả trên trang này đối với các dự án viết kỹ thuật có độ dài tiêu chuẩn, ngoại trừ ngày hoàn tất và đánh giá dự án sẽ muộn hơn.