Tạo ứng dụng 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 cung cấp gợi ý cho người viết kỹ thuật về cách hoàn thành các phần chính của ứng dụng để tham gia Phần Tài liệu. Thông tin này giúp bạn hiểu những yếu tố mà các tổ chức nguồn mở có thể cân nhắc khi chọn dự án viết kỹ thuật mà họ muốn cố vấn trong Phần Tài liệu.

Giới thiệu

Các nguyên tắc dưới đây thường áp dụng cho Phần Tài liệu. Mỗi tổ chức nguồn mở có thể có các tiêu chí đánh giá cụ thể. Bạn có thể liên hệ với bất kỳ tổ chức tham gia nào trước khi gửi đơn đăng ký, để thảo luận về các yêu cầu của họ và lên kế hoạch đề xuất dự án. Xem giai đoạn khám phá người viết kỹ thuật được mô tả trong hướng dẫn dành cho người viết kỹ thuật.

Biểu mẫu đăng ký

Biểu mẫu đăng ký có trong hướng dẫn dành cho người viết kỹ thuật trong giai đoạn đăng ký dành cho nhà viết kỹ thuật.

Sau khi gửi biểu mẫu, bạn có thể tiếp tục cập nhật thông tin trên biểu mẫu cho đến khi kết thúc giai đoạn đăng ký người viết kỹ thuật (ngày 28 tháng 6 năm 2019).

Thông tin cá nhân

Biểu mẫu đăng ký yêu cầu những thông tin cá nhân sau đây:

  • Tên của bạn: Cung cấp họ và tên. Phần Tài liệu sẽ không chia sẻ tên này với các tổ chức nguồn mở và sẽ không công bố tên này trên trang web.

  • Tên hiển thị do bạn chọn: Cung cấp tên mà bạn muốn dùng làm giá trị nhận dạng công khai trong quá trình bạn tham gia Phần Tài liệu. Bạn không nên sử dụng tên đầy đủ thật cho tên hiển thị của mình. Phần Tài liệu sẽ chia sẻ tên hiển thị của bạn với tổ chức nguồn mở mà bạn chỉ định trên biểu mẫu đăng ký của mình. Phần Tài liệu sẽ xuất bản tên hiển thị của bạn trên trang web trong danh sách các dự án viết kỹ thuật được chấp nhận.

  • Địa chỉ email: Cung cấp địa chỉ email liên kết với Tài khoản Google của bạn. (Bạn cần có Tài khoản Google để tham gia Phần Tài liệu. Bạn có thể sử dụng địa chỉ email không phải là Gmail bằng Tài khoản Google. Hãy xem bài viết trợ giúp này.) Phần Tài liệu sử dụng địa chỉ email của bạn để liên lạc với bạn và cung cấp tài nguyên trang web cho bạn. Phần Tài liệu sẽ chia sẻ địa chỉ email này với tổ chức nguồn mở mà bạn chỉ định trên biểu mẫu đăng ký của mình. Phần Tài liệu sẽ không xuất bản địa chỉ email này lên trang web.

Vui lòng xem phần bên dưới để biết nội dung tóm tắt về cách Phần Tài liệu sử dụng thông tin trong biểu mẫu đăng ký của bạn.

Thông tin về trải nghiệm của bạn khi viết nội dung kỹ thuật

Khi cố vấn nguồn mở và quản trị viên tổ chức kiểm tra một đề xuất dự án, họ sẽ quan tâm đến kinh nghiệm viết kỹ thuật của bạn. Bạn có thể cung cấp thông tin chi tiết trên biểu mẫu như sau:

  • Trải nghiệm gần đây khi viết nội dung kỹ thuật: Tối đa 3 mục để bạn có thể liệt kê các vai trò gần đây nhất của mình khi viết nội dung kỹ thuật hoặc kinh nghiệm làm việc. Nếu bạn có kinh nghiệm về tài liệu nguồn mở, hãy thêm vào đây. Tóm tắt vai trò của bạn, trách nhiệm vai trò và công việc bạn đã hoàn thành. Bạn có thể cung cấp ngày nếu thích hợp.

  • Đường liên kết đến sơ yếu lý lịch hoặc sơ yếu lý lịch của bạn: (Không bắt buộc). URL của một phiên bản sơ yếu lý lịch hoặc sơ yếu lý lịch (CV) mà bạn có thể truy cập công khai.

  • Đường liên kết đến mẫu bài tập của bạn: (Không bắt buộc.) URL của danh mục các bài viết mẫu có thể truy cập công khai hoặc đường liên kết riêng lẻ đến các ví dụ về tác phẩm của bạn.

  • Bất kỳ điều gì bạn muốn thêm: (Không bắt buộc.) Bất kỳ thông tin nào bạn muốn thêm ứng dụng này. Ví dụ: sự quan tâm đến tài liệu kỹ thuật, lý do bạn muốn tham gia Phần Tài liệu hoặc các trải nghiệm có liên quan khác.

Đề xuất dự án

Đề xuất dự án là bản tóm tắt công việc tài liệu mà bạn muốn hoàn tất trong khi làm việc với tổ chức nguồn mở đã chọn trong Phần Tài liệu.

Bạn có thể gửi tối đa 3 đề xuất dự án. Tất cả đề xuất dự án của bạn phải nằm trên cùng một biểu mẫu đăng ký.

Dành thời gian cho đề xuất dự án, lưu ý đến các nguyên tắc sau.

Công tác chuẩn bị:

  • Kiểm tra danh sách các tổ chức nguồn mở tham gia và chọn một hoặc nhiều tổ chức mà bạn quan tâm. Hãy xem các ý tưởng dự án mà từng tổ chức nguồn mở bạn chọn đã đề xuất.

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

  • Nếu tổ chức mà bạn quan tâm và chưa đề xuất ý tưởng nào, bạn có thể kiểm tra danh sách ý tưởng chung cho dự án và dựa trên một trong các ý tưởng đó. Bạn cũng có thể chọn đưa ra ý tưởng của riêng mình, cho dù tổ chức đã đăng ý tưởng hay chưa.

  • Hãy liên hệ với một hoặc nhiều tổ chức tham gia để thảo luận về các ý tưởng của dự án. Để 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 đưa ra một đề xuất dự án phù hợp.

Đề xuất dự án của bạn trên biểu mẫu đăng ký:

  • Tên tổ chức nguồn mở: Nhập tên của tổ chức nguồn mở mà bạn muốn làm việc trong Phần Tài liệu. Đây phải là một trong những tổ chức tham gia được hiển thị trên trang web Season of Tài liệu.

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

  • Tên dự án nguồn mở: Đây là tên của dự án nguồn mở bạn muốn xử lý trong Phần Tài liệu. Dự án phải thuộc về một trong các tổ chức tham gia được hiển thị trên trang web Season of Tài liệu. Đối với một số tổ chức, tên tổ chức và tên dự án có thể giống nhau.

  • Tên của dự án viết kỹ thuật mà bạn đề xuất. Cung cấp một tiêu đề ngắn gọn, có tính mô tả, tóm tắt được mục tiêu chính của tác phẩm bạn đề xuất.

  • Nội dung mô tả chi tiết. Cung cấp càng nhiều thông tin chi tiết càng tốt trong phần mô tả về dự án viết nội dung kỹ thuật mà bạn đề xuất. Bạn có thể nhập nhiều đoạn văn trong trường mô tả. Sau đây là một số ý tưởng về nội dung cần đưa vào:

    • Cung cấp thông tin chi tiết về tài liệu bạn đề xuất tạo/cập nhật. Nếu bạn định cập nhật một tài liệu hoặc trang web hiện có, hãy thêm một đường liên kết và mô tả các nội dung cập nhật được đề xuất. Nếu bạn đề xuất một tài liệu mới hoặc trang web mới, hãy mô tả nội dung và đối tượng.
    • Nêu lý do bạn đề xuất tài liệu mới hoặc nội dung cập nhật.
    • Nếu bạn đã thảo luận dự án này với ai đó thuộc tổ chức nguồn mở, hãy bao gồm một bản tóm tắt kết quả của các cuộc thảo luận đó.
    • Hãy chú ý đến ngôn ngữ và kiểu cách của đề xuất. Tổ chức nguồn mở có thể sử dụng các mã này làm yếu tố đánh giá đề xuất.
    • Đừng cung cấp đường liên kết đến nội dung mô tả dự án. Nội dung mô tả phải bao gồm tất cả các thông tin chi tiết chính thức về dự án của bạn. Tổ chức nguồn mở phải có khả năng lựa chọn dựa trên nội dung của biểu mẫu đăng ký thay vì dựa trên nội dung được giữ ở nơi khác. Bạn có thể liên kết đến nội dung khác bổ sung cho nội dung mô tả nếu cần liên kết, nhưng hãy lưu ý rằng chỉ nội dung của biểu mẫu đăng ký mới được dùng để lựa chọn dự án.

Các trường quan trọng khác trên biểu mẫu đăng ký

Dưới đây là nguyên tắc về những thông tin quan trọng khác mà bạn cần cung cấp trong biểu mẫu đăng ký:

  • Chọn dự án có thời lượng chuẩn hoặc dự án chạy trong thời gian dài: Khoảng thời gian tiêu chuẩn cho giai đoạn phát triển tài liệu của Phần Tài liệu là 3 tháng. Nếu dự án của bạn cần một khoảng thời gian dài hơn, bạn phải cho biết điều này trong biểu mẫu đăng ký sau khi tham khảo ý kiến của tổ chức nguồn mở mà bạn chọn. Xem nội dung mô tả về các dự án chạy trong thời gian dài.

  • Chấp nhận các khoản trợ cấp về Phần Tài liệu: Phần Tài liệu sẽ chi trả một khoản tiền cho những người viết nội dung kỹ thuật đã hoàn thành dự án của họ, với điều kiện người viết nội dung kỹ thuật muốn chấp nhận phụ cấp. Xem thông tin về chi phí cho người viết nội dung kỹ thuật. Tiền thưởng này là không bắt buộc. Nếu bạn không muốn nhận trợ cấp, hãy cho biết lựa chọn của bạn trong biểu mẫu đăng ký.

Cách Phần Tài liệu sử dụng thông tin từ biểu mẫu đăng ký của bạn

Phần này tóm tắt cách Phần Tài liệu sử dụng thông tin từ biểu mẫu đăng ký của bạn. Các phần trước của trang này mô tả chi tiết về các trường chính.

Bảng này liệt kê các trường chính. Đối với mỗi trường, bảng này cho biết phần Tài liệu:

  • Chuyển thông tin cho tổ chức nguồn mở mà bạn đã chỉ định trên biểu mẫu đăng ký của mình.
  • Công bố thông tin trong danh sách các dự án viết kỹ thuật được chấp nhận trên trang web Season of Tài liệu.
Thông tin trên biểu mẫu Được chia sẻ với tổ chức nguồn mở? Hiển thị trên trang web Phần Tài liệu?
Họ và tên
Tên hiển thị
Địa chỉ email
Kinh nghiệm viết nội dung kỹ thuật gần đây
Đường liên kết để sơ yếu lý lịch hoặc sơ yếu lý lịch
Đường liên kết đến các mẫu công việc
Mọi mục khác bạn muốn thêm
Tên dự án/tổ chức nguồn mở
Tên và nội dung mô tả dự án viết nội dung kỹ thuật
Dự án dài hạn hoặc dự án có thời lượng chuẩn
Chấp nhận trợ cấp

Khoá đối với các ký hiệu được sử dụng trong bảng trên:

Biểu tượng Ý nghĩa của biểu tượng
Có
Không

Ghi chú

Dưới đây là một vài điểm khác cần lưu ý:

  • Gửi nhiều đề xuất dự án: Bạn có thể gửi nhiều đề xuất dự án, nhưng Phần Tài liệu chỉ chấp nhận một đề xuất dự án cho mỗi người viết kỹ thuật. Bạn chỉ có thể gửi một biểu mẫu đăng ký. Biểu mẫu này cho phép tối đa 3 đề xuất dự án.

  • Tổng số dự án viết kỹ thuật trong chương trình: Phần Tài liệu chỉ có thể chấp nhận một số dự án viết kỹ thuật tối đa nhất định. Xem cách hoạt động của quy trình phân bổ vị trí.