Trang này chứa thông tin chi tiết về một dự án viết nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.
Tóm tắt dự án
- Tổ chức nguồn mở:
- The Linux Foundation
- Tác giả kỹ thuật:
- xiaoya
- Tên dự án:
- Tài liệu xây dựng cho dự án gắn huy hiệu D&I của CHAOSS
- Thời lượng dự án:
- Thời hạn tiêu chuẩn (3 tháng)
Mô tả dự án
Tôi đưa nội dung chính vào như sau: Các mục tiêu chính là làm phong phú các tác phẩm liên quan đến tài liệu trong quy trình làm việc, viết tài liệu gắn huy hiệu D&I dành cho cộng đồng và lưu trữ tài liệu được xử lý bằng nhiều ngôn ngữ trên nền tảng chuyên biệt. Bạn có thể chia các mục tiêu này thành các nhiệm vụ nhỏ sau: Cập nhật và tích hợp mẫu PR hiện tại để sử dụng nhiều chỉ số D&I hơn và đa dạng hoá các câu hỏi. Soạn thảo tổng quan về khái niệm để giới thiệu chương trình huy hiệu D&I Soạn thảo nguyên tắc áp dụng bằng cách sử dụng tài liệu JOSS làm tài liệu tham khảo Dự thảo nguyên tắc của người đánh giá bằng cách sử dụng tài liệu JOSS làm tài liệu tham khảo Tài liệu giải thích các vai trò và trách nhiệm tương ứng khác nhau trong suốt quy trình làm việc. Tài liệu giải thích cách áp dụng probot của GitHub cho quy trình Nguyên tắc dành cho người đóng góp để cho biết cách một người mới có thể đóng góp dự án hoặc tài liệu. Trợ giúp công việc dịch tài liệu, kiểm tra hiệu quả hoạt động của bản dịch tự động, đặc biệt là tiếng Trung và thực hiện dịch thủ công nếu cần. Sắp xếp tài liệu ở định dạng đa ngôn ngữ dựa trên công việc dịch. Sử dụng Gitbook, Read the Doc hoặc GitHub Wiki để lưu trữ tài liệu.
Thành phẩm 1. Cung cấp thêm chỉ số và câu hỏi đa dạng cho mẫu PR dự án và sự kiện. Sản phẩm này bao gồm tất cả công việc liên quan đến tài liệu trong quy trình làm việc, đặc biệt là mẫu PR được chuẩn bị để người đăng ký hoàn tất. Đây là thành phần cốt lõi của quy trình làm việc vì nó đóng vai trò quyết định trong việc đánh giá người đánh giá, vì vậy, hình thức và nội dung của câu hỏi sẽ được hoàn thiện trong suốt quá trình xây dựng quy trình làm việc và tôi sẽ phân phối sản phẩm này từ các điểm sau: Dựa trên nhiều loại sự kiện hoặc dự án Kết hợp với nhiều chỉ số D&I hơn Sử dụng nhiều cách đặt câu hỏi với yêu cầu câu trả lời dựa trên bằng chứng
Có thể cung cấp 2. Dưới đây là bản nháp về cấu trúc tài liệu dành cho cộng đồng
Tổng quan về huy hiệu D&I
Giới thiệu
Mục tiêu
Các cấp huy hiệu
Đăng ký huy hiệu
Đăng ký huy hiệu sự kiện
Mẫu bài đăng về sự kiện
Đăng ký huy hiệu dự án
Mẫu bài đăng về dự án
Xem xét
Cách trở thành người xem xét
Chính sách xung đột lợi ích của huy hiệu D&I
Tiêu chí xem xét
Danh sách kiểm tra xem xét
Vai trò và trách nhiệm
Người đăng ký – Tạo bài đăng về dự án
Người xem xét – Xem xét bài đăng về dự án
Người kiểm duyệt – Xem xét bài đăng và bài tập xem xét
Người duy trì – Kiểm tra cuối cùng và hợp nhất bài đăng về dự án
Probot
Nguyên tắc ứng xử của huy hiệu D&I
Cách đóng góp
Có thể cung cấp 3. Sắp xếp tài liệu theo định dạng đa ngôn ngữ và lưu trữ tài liệu trên các nền tảng như Read the docs hoặc Gitbook.
Trong quy trình làm việc hiện tại, một số công việc dịch tự động đang được khám phá. Tôi sẽ giúp kiểm tra kết quả dịch, đặc biệt là tiếng Trung, chẳng hạn như độ chính xác và lưu loát của bản dịch. Tài liệu sẽ tồn tại dưới dạng một định dạng, tôi sẽ tìm hiểu các nền tảng lưu trữ tài liệu kỹ thuật như Đọc tài liệu, Gitbook và GitHub wiki và chọn nền tảng phù hợp nhất để lưu trữ tài liệu hướng tới cộng đồng mở.