Trang này chứa thông tin chi tiết về một dự án viết kỹ thuật được chấp nhận cho Phần Google Tài liệu.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Nền tảng Linux
- Người viết nội dung kỹ thuật:
- thông báo
- Tên dự án:
- Tài liệu xây dựng cho Dự án Huy hiệu D&I của CHAOSS
- Thời lượng dự án:
- Thời gian tiêu chuẩn (3 tháng)
Mô tả dự án
Tôi đưa nội dung chính vào như sau: Mục tiêu chính là làm phong phú thêm các tác phẩm liên quan đến tài liệu trong quy trình công việc, viết tài liệu về huy hiệu D&I liên quan đến 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 đặc biệt. Những tài liệu này có thể được tách thành các nhiệm vụ nhỏ sau đây: 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 các câu hỏi. Soạn một tài liệu tham khả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 dành cho người áp dụng bằng cách sử dụng tài liệu của JOSS làm tài liệu tham khảo Soạn thảo các nguyên tắc dành cho người đánh giá, sử dụng tài liệu của 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 trong suốt quy trình làm việc. Tài liệu giải thích cách áp dụng bot trên GitHub cho quy trình công việc Nguyên tắc dành cho người đóng góp cho thấy cách người mới tham gia 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 suất của bản dịch tự động, đặc biệt là trong tiếng Trung và thực hiện các công việc dịch thủ công nếu cần. Sắp xếp tài liệu theo định dạng đa ngôn ngữ dựa trên bản dịch. Sử dụng Gitbook, Read the Doc hoặc GitHub Wiki để lưu trữ tài liệu.
Sản phẩm 1. Làm phong phú thêm mẫu PR sự kiện và dự án với nhiều chỉ số và nhiều câu hỏi hơn. Tài liệu này bao gồm mọi 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 viên hoàn thành. Tôi cho rằng thành phần cốt lõi của quy trình công việc vì nó đóng vai trò quyết định trong việc đánh giá của người đánh giá. Vì vậy, hình thức và nội dung của các câu hỏi sẽ được hoàn thiện trong suốt quá trình xây dựng quy trình. Tôi sẽ đưa ra những điểm sau đây: Dựa trên các loại sự kiện hoặc dự án cần đến các chỉ số bằng chứng khác nhau
Sản phẩm 2. Dưới đây là bản thảo cấu trúc tài liệu dành cho cộng đồng
Tổng quan về việc đánh giá huy hiệu D&I
Giới thiệu
Mục tiêu
Cấp huy hiệu
Đăng ký nhận huy hiệu
Đăng ký huy hiệu sự kiện
Mẫu PR sự kiện
Đăng ký huy hiệu dự án
Mẫu PR dự án
Đánh giá
Cách trở thành người đánh giá
Chính sách đánh giá xung đột về quyền lợi
D&I
Đánh giá tiêu chí đánh giá
Vai trò và người kiểm duyệt trách nhiệm
Người kiểm duyệt thực hiện việc đánh giá
Tiêu chí đánh giá
Người kiểm duyệt và người kiểm duyệt không tốt
Sản phẩm 3. Sắp xếp tài liệu theo định dạng đa ngôn ngữ và lưu trữ trên các nền tảng như Đọc tài liệu 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 tìm hiểu. Tôi sẽ giúp bạn kiểm tra hiệu suất của bản dịch, đặc biệt là trong tiếng Trung, chẳng hạn như độ chính xác và độ trôi chảy của bản dịch. Tài liệu này sẽ tồn tại dưới dạng đị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 rồi chọn một nền tảng phù hợp nhất để lưu trữ tài liệu dành cho cộng đồng mở.