Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan proyek
- Organisasi open source:
- The Linux Foundation
- {i>Technical writer <i}(Penulis teknis):
- xiaoya
- Nama project:
- Membuat Dokumentasi untuk Project Badge D&I CHAOSS
- Durasi project:
- Durasi standar (3 bulan)
Project description
Saya menempatkan konten utama dalam hal berikut: Tujuan utamanya adalah memperkaya pekerjaan terkait dokumen dalam alur kerja, menulis dokumentasi pemberian badge D&I yang ditampilkan kepada komunitas, dan menghosting dokumentasi yang diproses dalam beberapa bahasa di platform khusus, yang dapat dibagi menjadi tugas mikro berikut: Memperbarui dan mengintegrasikan template PR saat ini dalam penggunaan lebih banyak metrik D&I dan memvariasikan pertanyaan. Buat draf ringkasan konseptual untuk memperkenalkan program pemberian badge D&I Buat draf panduan pelamar menggunakan dokumen JOSS sebagai referensi Buat draf panduan 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 cara pendatang baru berkontribusi pada project atau dokumen. Membantu pekerjaan terjemahan dokumen, memeriksa performa terjemahan otomatis terutama dalam bahasa China, dan melakukan pekerjaan terjemahan manual jika diperlukan. Atur dokumentasi dalam format multibahasa berdasarkan pekerjaan terjemahan. Gunakan Gitbook, Read the Doc, atau GitHub Wiki untuk menghosting dokumen.
Hasil kerja 1. Perkaya {i>template<i} PR proyek dan acara dengan lebih banyak metrik dan pertanyaan yang beragam. Hasil ini mencakup semua pekerjaan terkait dokumen dalam alur kerja, terutama template PR yang disiapkan untuk diselesaikan oleh pelamar. Menurut saya, ini adalah komponen inti alur kerja karena memainkan peran yang menentukan dalam evaluasi peninjau, sehingga bentuk dan konten pertanyaan akan disempurnakan selama pembuatan alur kerja, dan saya akan menyampaikannya dari poin berikut: Berdasarkan berbagai jenis peristiwa atau project Menggabungkan dengan lebih banyak metrik D&I Menggunakan berbagai cara pertanyaan dengan memerlukan jawaban berbasis bukti
Hasil akhir 2. Berikut adalah draf struktur dokumentasi yang ditampilkan kepada komunitas
Ringkasan Badge D&I
Pengantar
Sasaran
Tingkat badge
Mengajukan permohonan badge
Mengajukan permohonan badge acara
Template PR acara
Mengajukan permohonan badge project
Template PR project
Peninjauan
Cara menjadi peninjau
Kebijakan Konflik Kepentingan Badge D&I
Kriteria peninjauan
Checklist peninjauan
Peran dan Tanggung Jawab
Pemohon - Membuat PR
Peninjau - Meninjau PR
Moderator - Untuk melihat peninjauan dan tugas peninjauan
Pengelola - Pemeriksaan Akhir dan penggabungan PR
Probot
Kode Etik Badge D&I
Cara berkontribusi
Hasil 3. Atur dokumen dalam format multibahasa dan hosting di platform seperti Read the docs atau Gitbook.
Dalam alur kerja saat ini, beberapa pekerjaan terjemahan otomatis sedang dieksplorasi. Saya akan membantu memeriksa seberapa baik hasil terjemahan dilakukan, terutama dalam bahasa China, seperti ketepatan dan kelancaran terjemahan. Dokumen akan ada 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 terbuka untuk komunitas.