Ý tưởng dự án

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.

Ý tưởng dự án là đề xuất của một tổ chức nguồn mở cho các dự án mà một người viết kỹ thuật có thể cộng tác với một người cố vấn trong phần Tài liệu.

Thông tin trên trang này dành cho quản trị viên và người cố vấn của tổ chức nguồn mở đang chuẩn bị danh sách ý tưởng dự án. Thông tin này cũng hữu ích cho người viết nội dung kỹ thuật làm nền cho việc tổ chức tham gia vào Season of Tài liệu.

Dự án mẫu

Sau đây là một số ý tưởng về loại dự án mà một người viết nội dung kỹ thuật có thể giải quyết:

  • Xây dựng một trang web tài liệu trên một nền tảng do người viết kỹ thuật và cố vấn nguồn mở quyết định, đồng thời xuất bản một bộ tài liệu cơ bản ban đầu trên trang web. Sau đây là một số ví dụ về nền tảng:

  • Tái cấu trúc tài liệu hiện có của dự án nguồn mở để cải thiện trải nghiệm người dùng hoặc một cấu trúc thông tin dễ tiếp cận hơn.

  • Viết phần giới thiệu tổng quan hoặc giới thiệu về một sản phẩm hoặc tính năng. Thông thường, một nhóm sẽ tạo tài liệu kỹ thuật từ dưới lên. Kết quả là tài liệu có rất nhiều thông tin chi tiết nhưng lại khó hiểu được toàn bộ sản phẩm. Người viết nội dung kỹ thuật có thể khắc phục vấn đề này.

  • Tạo hướng dẫn cho trường hợp sử dụng phổ biến.

  • Tạo một bộ hướng dẫn tập trung vào từng công việc cụ thể.

  • Tạo hướng dẫn dành cho cộng tác viên, bao gồm thông tin cơ bản về cách bắt đầu với tư cách là cộng tác viên cho dự án nguồn mở, cũng như mọi quy tắc liên quan đến thoả thuận cấp phép, quy trình lấy yêu cầu và bài đánh giá, cách xây dựng dự án, v.v.

Các ý tưởng nêu trên có chủ đích về phạm vi và quy mô. Thời gian thực hiện một dự án phụ thuộc vào một số yếu tố, bao gồm cả kích thước của bộ tài liệu, độ phức tạp của sản phẩm, kinh nghiệm của người viết kỹ thuật và cố vấn nguồn mở, các công cụ và quy trình do dự án nguồn mở cung cấp, v.v.

Mục tiêu của danh sách trên là để giúp bạn bắt đầu. Bạn cũng có thể đề xuất các loại dự án khác.

Xuất bản danh sách các ý tưởng dự án

Bạn nên xuất bản ý tưởng về dự án của mình trên một trang web công khai, trong một bài đăng trên blog hoặc trong một số tài liệu hiển thị công khai khác.

Trang ý tưởng dự án của bạn nên bao gồm:

  • Thông tin về tổ chức sử dụng nguồn mở của bạn:

    • Tên tổ chức.
    • Nội dung mô tả về tổ chức.
    • Đường liên kết đến kho lưu trữ nguồn mở và/hoặc trang web của bạn.
    • (Không bắt buộc) Địa chỉ email để liên hệ với tổ chức của bạn về Phần Tài liệu. Địa chỉ này phải giống với địa chỉ email mà bạn đưa vào biểu mẫu đăng ký tham gia Phần Tài liệu của tổ chức.
    • (Không bắt buộc) Thông tin về quản trị viên và người cố vấn trong tổ chức của bạn, chẳng hạn như tên hiển thị của họ. Những tên này phải giống với tên hiển thị mà bạn đưa vào biểu mẫu đăng ký cho phần Tài liệu của tổ chức.

  • Thông báo rằng tổ chức của bạn đang đăng ký tham gia Phần Tài liệu năm nay. Trang quảng cáo và báo chí bao gồm biểu trưng và nội dung khác mà bạn có thể sử dụng khi nói về Phần Tài liệu.

  • (Các) ý tưởng dự án của bạn, bao gồm cả thông tin được mô tả dưới đây cho mỗi ý tưởng dự án.

Khi tạo đơn đăng ký Phần Tài liệu cho tổ chức của mình, bạn nên thêm một đường liên kết đến trang ý tưởng dự án của mình.

Thông tin trong mỗi ý tưởng dự án

Mỗi ý tưởng dự án phải bao gồm ít nhất các thông tin sau:

  • Tên dự án: Chọn một tiêu đề ngắn gọn nhưng dễ mô tả.
  • Nội dung mô tả: Nội dung mô tả dài hơn về công việc cần thực hiện trên tài liệu. Mô tả chi tiết ý tưởng ban đầu của bạn. Tạo cơ hội cho những người viết nội dung kỹ thuật quan tâm đến việc mở rộng hoặc tinh chỉnh ý tưởng.

  • Tài liệu có liên quan:

    • Liên kết đến dự án nguồn mở cần tài liệu.
    • Nếu bạn đang đề xuất một dự án viết kỹ thuật có liên quan đến các nội dung cập nhật cho một bộ tài liệu hiện có, hãy liên kết đến bộ tài liệu đó.
    • Nếu bạn đề xuất một bản hướng dẫn hoặc bộ hướng dẫn thực hiện, hãy mô tả các tính năng hoặc trường hợp sử dụng cần ghi lại tài liệu.
    • Nếu bạn đề xuất hướng dẫn dành cho người đóng góp, hãy liên kết đến tệp README hiện có bất kỳ hoặc tài liệu nào khác có liên quan (nếu có). Nếu chưa có gì thì có thể nói điều đó.
    • Cung cấp đường liên kết đến tài liệu tương tự trong các dự án khác (nếu thích hợp).

Tầm quan trọng của ý tưởng dự án

Ý tưởng dự án của bạn có ý nghĩa quan trọng theo một số cách:

  • Việc lên ý tưởng giúp tổ chức của bạn xây dựng các nhiệm vụ liên quan đến tài liệu cần thiết và chuẩn bị làm việc với một người viết nội dung kỹ thuật.
  • Ý tưởng dự án giúp các quản trị viên chương trình của Google biết được loại công việc mà người viết kỹ thuật sẽ xử lý khi họ bắt đầu mối quan hệ cố vấn với tổ chức của bạn. Quản trị viên chương trình của Google sử dụng ý tưởng dự án để đánh giá cam kết của tổ chức về việc tham gia Phần Tài liệu và cố vấn cho một người viết nội dung kỹ thuật trong suốt chương trình.
  • Các ý tưởng dự án thu hút những người viết nội dung kỹ thuật quan tâm đến tổ chức của bạn. Họ có thể sử dụng các dự án đề xuất của bạn làm cơ sở cho đề xuất dự án của riêng họ.