Project DIPY

Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.

Ringkasan project

Organisasi open source:
DIPY
Penulis teknis:
Areesha Tariq
Nama project:
Fokus pengguna akhir dan restrukturisasi tingkat tinggi
Durasi project:
Durasi standar (3 bulan)

Project description

Saya adalah Software Engineer dan memiliki keahlian dalam penulisan teknis. Saya memiliki pengalaman lebih dari 4 tahun dalam menulis dokumentasi software, panduan pengguna, manual, deskripsi project yang berkualitas tinggi. Saya tinggal di Islamabad, Pakistan (Zona Waktu: UTC +5). Saat ini, saya bekerja sebagai magang di Outreachy yang akan berlanjut hingga 18 Agustus. Saya berpartisipasi dalam Google Season of Docs sebagai Penulis Teknis di organisasi OpenELIS Global. Dokumentasi aslinya dalam bahasa Prancis, terbatas, dan sudah tidak berlaku, jadi saya membuat dokumentasi pengguna akhir yang lengkap dan diperbarui dalam bahasa Inggris. Saya terpilih di Outreachy di organisasi Perl & Raku untuk putaran Mei-Agustus 2020 sebagai developer backend server Open Food Facts. Selain pengembangan {i>back-end<i}, salah satu tugas utama magang ini adalah membuat dokumentasi untuk modul dan fungsi dalam format POD. Saya memasuki dunia open source tahun lalu saat berkontribusi dalam beberapa project open source dan kemudian berpartisipasi dalam Google Season of Docs. Dan tahun ini, saya terpilih dalam Outreachy yang mendukung keberagaman dalam open source dan software gratis. Saya memiliki pemahaman yang kuat tentang Git karena project Outreachy saya dihosting di GitHub dan saya telah berkontribusi secara rutin ke Open Food Facts dan Mozilla Fenix sejak Maret. Saya adalah pengguna Linux selama lebih dari 3 tahun terakhir dan sejak saat itu sudah menggunakan perintah terminal.

Alat dan bahasa dokumentasi yang telah saya gunakan adalah Sphinx, Read the docs, Markdown. Saya menyukai ide ini dan ingin mengerjakannya karena saya memiliki pengalaman yang relevan dan ingin menggunakan pengetahuan dan keterampilan saya untuk berkontribusi pada DIPY. Saya memiliki pengalaman di bidang pemrosesan gambar digital, computer vision, machine learning. Hal ini akan membantu saya lebih memahami neuroimaging dan membantu dalam membuat dokumentasi. Saya memiliki pengalaman yang luas di bidang medis. Saya mengembangkan situs web medis untuk dokter, pasien, laboratorium, pengemudi ambulans. Saya mengerjakan sistem lain yang digunakan oleh dokter, pasien, perawat, asisten lab, dan peneliti. Hal ini akan membantu saya dalam membuat dokumentasi yang akan lebih mudah dipahami oleh audiens.

Saya telah membaca dokumentasi DIPY dan telah mencatat beberapa kekurangan dalam dokumentasi tersebut. Ada beberapa celah dalam dokumentasi yang ingin saya tingkatkan. Status Dokumentasi Saat Ini: Dokumentasi tidak memiliki struktur dan desain tertentu Dokumentasi dapat merepotkan dan memakan waktu, terutama bagi pengguna baru untuk menavigasinya Pengguna mungkin kesulitan mendapatkan informasi dari panduan Konten dokumentasi perlu ditingkatkan Sebagai pengguna baru, saya merasa sulit mengakses panduan pengguna dan panduan developer. Dokumentasi perlu dibentuk ulang agar informasi yang diperlukan pengguna dapat diakses dengan mudah Dokumentasi tidak konsisten

Saya berencana untuk melakukan hal berikut:

Menentukan struktur dan template tertentu untuk dokumentasi Membentuk ulang dokumentasi sehingga pengguna dapat dengan mudah menavigasi dan menemukan informasi yang diperlukan Membuat roadmap atau daftar item pekerjaan untuk melibatkan komunitas dalam pekerjaan dokumentasi lebih lanjut Menentukan template untuk panduan pengguna dan panduan developer Menentukan template untuk panduan kontribusi Menulis ulang, menyusun ulang, dan memperbarui panduan pengguna, panduan pengembangan, dan panduan kontribusi (yang dapat membantu dan memotivasi pengguna baru untuk berkontribusi pada project) Menambahkan gambar non-tekstual untuk meningkatkan kualitas penjelasan tekstual Meningkatkan konsistensi di seluruh dokumentasi Membuat dokumentasi untuk antarmuka command line baru

Panduan Pengguna:

Untuk panduan pengguna, saya akan berfokus menggunakan bahasa sederhana dan jelas untuk membantu pengguna memahami sistem yang paling kompleks sekalipun. Jargon, akronim, dan info orang dalam lainnya yang mungkin tidak diketahui pengguna baru akan dihindari untuk pengalaman pengguna yang lebih baik. Saya juga akan berfokus pada penggunaan konten visual, termasuk gambar, screenshot yang dianotasi, grafik, dan video, yang dengan cepat menunjukkan cara kerja sistem kepada pengguna. Dokumentasi yang baik memerlukan hierarki judul dan subjudul yang memungkinkan pengguna mengetahui apa yang akan ditampilkan oleh setiap bagian. Dan hierarki tersebut harus mengikuti alur logis yang membantu pengguna belajar menggunakan sistem dengan cara yang paling bermanfaat. Salah satu tujuan utama project ini adalah membuat konten yang mudah diakses. Semua dokumen dan panduan akan mematuhi gaya yang konsisten. Penggunaan {i>font<i} yang konsisten dan warna yang saling melengkapi di banyak dokumen adalah suatu keharusan. Saya akan memastikan bahwa pengguna memiliki akses ke lebih banyak referensi organisasi tentang cara meraih kesuksesan dengan sistem.

Panduan Developer:

Panduan Developer menyertakan panduan dan materi referensi yang luas untuk membantu developer dalam membuat kontribusi ke kode sumber DIPY. Panduan ini mencoba menjelaskan berbagai opsi yang tersedia bagi Anda, sehingga Anda dapat menggunakan pendekatan yang tepat, bergantung pada hal yang ingin dicapai. Panduan pengembangan perlu membentuk dan menyusun ulang struktur. Saya akan menulis ulang konten panduan developer. Membangun dependensi, panduan kontribusi, panduan gaya, konvensi coding, panduan dokumentasi, menginstal lingkungan pengembangan, proses debug, panduan pengujian, dan hal-hal terkait akan disertakan dan mudah diakses oleh developer. Saat kontributor baru yang bersemangat bergegas ke project Anda untuk membuat kontribusi open source pertamanya, mereka mengandalkan panduan kontribusi sebagai panduan mereka. Dengan demikian panduan akan mudah dibaca, menyeluruh, dan ramah. Panduan kontribusi adalah dokumen bermanfaat yang menjelaskan cara orang dapat berkontribusi pada project open source. Berkontribusi pada project harus dibuat semudah dan setransparan mungkin bagi pengguna, baik itu: Mengirimkan perbaikan Melaporkan bug Menjadi pengelola Mendiskusikan status kode saat ini Menyarankan fitur baru

TEMPLATE

Ini adalah salah satu template yang dapat digunakan untuk panduan kontribusi. Struktur ini dapat diubah dan bagian dapat ditambahkan atau dihapus sesuai dengan persyaratan dokumen.

Berkontribusi pada DIPY

  • Catatan Selamat Datang

TOC

Kode Etik

  • Standar Kami
  • Contoh perilaku yang berkontribusi dalam menciptakan lingkungan yang positif
  • Contoh perilaku yang tidak dapat diterima oleh peserta
  • Tanggung Jawab Kami
  • Tanggung jawab pengelola project
  • Cakupan

Cakupan Kode Etik

Apa yang perlu saya ketahui untuk membantu?

Jika Anda ingin membantu dengan kontribusi kode yang digunakan project kami [insert list of programming languages, frameworks, or tools that your project uses]. Jika Anda belum siap untuk berkontribusi pada kode, tidak masalah. Anda juga dapat melihat masalah dokumentasi [link to the docs label or tag on your issue tracker] atau masalah desain yang kami miliki [link to design label or tag on issue tracker if your project tracks design issues]. Jika Anda tertarik untuk memberikan kontribusi kode dan ingin mempelajari lebih lanjut teknologi yang kami gunakan, lihat daftar di bawah. Sertakan daftar berbutir referensi (tutorial, video, buku) yang dapat digunakan kontributor baru untuk mempelajari hal-hal yang perlu diketahui pengguna untuk berkontribusi pada project.

Menyiapkan lingkungan pengembangan

Di bagian ini, saya akan menambahkan prosedur penginstalan dan dependensi yang perlu diinstal. Instal $project dengan menjalankan: install project

  • Kode Sumber: github.com/$project/$project
  • Issue Tracker: github.com/$project/$project/issues

Cara Berkontribusi

Cara melaporkan bug

  • Sebelum Mengirim Laporan Bug
  • How Do I Submit A (Good) Bug Report?

Cara mengirimkan perubahan

  • Protokol permintaan pull
  • Tanggapan dari tim
  • Kecepatan respons

Cara meminta peningkatan kualitas

  • Sebelum Mengirimkan Saran Peningkatan
  • How Do I Submit A (Good) Enhancement Suggestion?

Kontribusi kode pertama Anda

  • Masalah Pemula
  • Bantuan terkait masalah #### Permintaan Pull
  • Proses pembuatan permintaan pull
  • Pastikan semua pemeriksaan status berhasil.

Bagaimana jika pemeriksaan status gagal?

  • Menulis Pengujian
  • Cakupan Pengujian

Panduan Gaya

  • Pesan Git commit
  • Gaya standar

Dukungan

Jika Anda mengalami masalah, harap beri tahu kami. Jika memerlukan bantuan, Anda dapat mengajukan pertanyaan di milis kami yang berlokasi di: project@google-groups.com, chat IRC, atau [cantumkan platform komunikasi lain yang digunakan project Anda].

Lisensi

Bagian ini akan memberi tahu tentang lisensi proyek.

Komitmen waktu dan komunikasi:

Saya akan memberikan 45+ jam seminggu, tetapi jika terjadi kesalahan, saya akan mengganti jam tersebut pada akhir pekan. Selama periode ikatan komunitas, saya akan mendiskusikan sarana komunikasi dan akan menyelesaikan rapat mingguan, sarana, dan waktu untuk rapat tersebut dengan mentor saya. Saya akan memberikan informasi terbaru kepada mentor tentang pekerjaan saya; akan membagikan detail pekerjaan saya melalui email kepada mentor. Saya akan lebih memilih TeamViewer untuk berkomunikasi, karena mudah digunakan dengan banyak fitur seperti berbagi layar, dll.