Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- Linux Foundation
- Penulis teknis:
- Xiaoya
- Nama proyek:
- Dokumentasi Build untuk CHAOSS D&I Badging Project
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Saya memberikan konten utama sebagai berikut: Tujuan utamanya adalah memperkaya karya terkait dokumen dalam alur kerja, menulis dokumentasi badge D&I yang berhubungan dengan komunitas, dan menghosting dokumentasi pemrosesan multibahasa di platform khusus, yang dapat dipisahkan menjadi tugas mikro berikut: Memperbarui dan mengintegrasikan template PR saat ini dalam penggunaan lebih banyak metrik D&I dan beragam pertanyaan. Buat draf ringkasan konseptual untuk memperkenalkan program pemberian badge D&I Membuat draf panduan applier menggunakan dokumen JOSS sebagai referensi Membuat draf pedoman peninjau menggunakan dokumen JOSS sebagai referensi Dokumen yang menjelaskan berbagai peran dan tanggung jawab masing-masing di seluruh alur kerja. Dokumen yang menjelaskan cara probot GitHub diterapkan untuk alur kerja Panduan kontributor untuk menunjukkan bagaimana pendatang baru dapat berkontribusi pada project atau dokumen. Membantu pekerjaan penerjemahan dokumen, memeriksa performa terjemahan otomatis terutama dalam bahasa China, dan melakukan terjemahan manual jika diperlukan. Mengatur dokumentasi dalam format multibahasa berdasarkan karya terjemahan. Gunakan Gitbook, Read the Doc, atau GitHub Wiki untuk menghosting dokumen.
Hasil kerja 1. Perkaya template PR proyek dan acara dengan lebih banyak metrik dan pertanyaan yang beragam. Hasil kerja ini mencakup semua pekerjaan terkait dokumen dalam alur kerja, terutama template PR yang disiapkan untuk diselesaikan pemohon. Menurut saya, inilah yang menjadi komponen inti alur kerja karena berperan sangat penting dalam evaluasi peninjau, sehingga bentuk dan isi pertanyaan akan disempurnakan sepanjang penyusunan alur kerja, dan saya akan menyampaikannya dari poin-poin berikut: Mengacu pada berbagai jenis acara atau proyek Mengandalkan berbagai jenis pertanyaan atau proyek yang memerlukan lebih banyak metode pembuktian
Hasil 2. Di bawah ini adalah draf struktur dokumentasi yang berhubungan dengan komunitas
Ringkasan struktur badge D&I
Pengantar
Tingkat Badge
Sasaran
Mengajukan permohonan badge
Mengajukan permohonan badge acara
Template PR acara
Mendaftar untuk badge project
Template PR project
Peninjauan
Cara menjadi peninjau
Kebijakan Konflik Kepentingan D&I
Tinjau
Kriteria Peninjauan Daftar Tugas
Tinjauan Tugas dan Tanggung Jawab yang Buruk
Hasil kerja 3. Atur dokumen dalam format multibahasa dan simpan di platform seperti Read the docs atau Gitbook.
Dalam alur kerja saat ini, beberapa karya terjemahan otomatis sedang dieksplorasi. Saya akan membantu memeriksa seberapa baik performa hasil terjemahan, terutama dalam bahasa China, seperti ketepatan dan kefasihan terjemahan. Dokumen akan tersedia sebagai format, saya akan menyelidiki platform hosting dokumen teknis seperti Read the docs, Gitbook, dan GitHub wiki, dan memilih platform yang paling sesuai untuk menghosting dokumentasi yang dihadapi komunitas terbuka.