Hợp tác với nhà văn 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.

Dưới đây là một số nguyên tắc dành cho các tổ chức nguồn mở về cách làm việc với người viết kỹ thuật mà bạn đang cố vấn cho Phần Tài liệu:

  • Hãy giới thiệu cho người viết nội dung kỹ thuật về thế giới nguồn mở và cộng đồng của bạn.
  • Giúp người viết kỹ thuật sử dụng các công cụ và quy trình liên quan đến việc đóng góp cho dự án của bạn.
  • Giải thích sản phẩm của bạn một cách chi tiết để người viết kỹ thuật có được sự hiểu biết chắc chắn về khái niệm của sản phẩm. Điều này có thể giúp người viết kỹ thuật cảm thấy tự tin hơn và có căn cứ đáng tin hơn khi viết bài về dự án.
  • Mô tả nhu cầu của độc giả/người dùng, tức là nhu cầu của những nhà phát triển sử dụng sản phẩm của bạn và/hoặc các nhóm khác cũng dùng sản phẩm.
  • Hội thảo các trường hợp sử dụng quan trọng với người viết nội dung kỹ thuật để giúp họ thiết kế tài liệu cần thiết.
  • Xem qua mã này khi người viết kỹ thuật cần phải hiểu mã trước khi viết tài liệu.
  • Giúp người viết nội dung kỹ thuật liên hệ với các chuyên gia phụ trách vấn đề cần thiết. Tức là những nhà phát triển hoặc những người đóng góp khác cho dự án sẽ chịu trách nhiệm về khía cạnh của sản phẩm trong tài liệu này.
  • Đảm bảo rằng người viết kỹ thuật có được thời gian và tài nguyên cần thiết từ các chuyên gia trong lĩnh vực và mọi thành viên khác trong cộng đồng.
  • Hãy làm việc với tác giả kỹ thuật để thêm các mã mẫu có ý nghĩa vào tài liệu nếu thích hợp.

Những điều cần lưu ý

Người cố vấn nguồn mở trong Phần Tài liệu không nhất thiết là người viết nội dung kỹ thuật. Người cố vấn không cần phải có kỹ năng lập tài liệu. Người viết nội dung kỹ thuật đưa những kỹ năng đó vào dự án và mối quan hệ cố vấn.

Thay vào đó, người cố vấn sẽ chia sẻ kiến thức về cộng đồng nguồn mở, sản phẩm cũng như các quy trình và công cụ mà dự án nguồn mở sử dụng.

Một kết quả quan trọng của mối quan hệ cố vấn là người viết nội dung kỹ thuật có được trải nghiệm thành công và bổ ích trong Phần Tài liệu năm nay. Trải nghiệm vui vẻ giúp cải thiện cơ hội mà người viết nội dung kỹ thuật sẽ tiếp tục đóng góp cho dự án nguồn mở sau khi mùa Tài liệu kết thúc năm nay và những người viết nội dung kỹ thuật khác sẽ nhiệt tình làm việc với nguồn mở.