Project DIPY

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

Ringkasan proyek

Organisasi open source:
DIIPKAN
Penulis teknis:
Areesha Tariq
Nama proyek:
Restrukturisasi tingkat tinggi dan fokus pengguna akhir
Durasi proyek:
Durasi standar (3 bulan)

Project description

Saya seorang Software Engineer dan memiliki keahlian di bidang penulisan teknis. Saya memiliki lebih dari 4 tahun pengalaman dalam menulis dokumentasi software, panduan pengguna, manual, deskripsi project berkualitas tinggi. Saya tinggal di Islamabad, Pakistan (Zona Waktu: UTC + 5). Saat ini, saya bekerja sebagai peserta magang di Pendamping yang akan berlanjut hingga 18 Agustus. Saya berpartisipasi dalam Google Season of Docs sebagai Technical Writer di organisasi OpenELIS Global. Dokumentasi aslinya menggunakan bahasa Prancis, terbatas, dan ketinggalan zaman, jadi saya membuat dokumentasi pengguna akhir yang ekstensif dan diperbarui dalam bahasa Inggris. Saya terpilih di Mediationy di organisasi Perl & Raku untuk sekitar Mei-Agustus 2020 sebagai developer backend server Open Food Facts. Selain pengembangan {i>back-end<i}, salah satu tugas utama dari program magang ini adalah membuat dokumentasi untuk modul dan fungsi dalam format POD. Tahun lalu saya memasuki dunia open source saat berkontribusi dalam beberapa project open source dan kemudian berpartisipasi dalam Google Season Dokumen. Dan tahun ini, saya terpilih dalam program Pendampingan yang mendukung keragaman dalam perangkat lunak {i>open source<i} dan perangkat lunak gratis. Saya sangat menyukai Git karena proyek Pendampingan saya dihosting di GitHub dan saya telah memberikan kontribusi rutin untuk Open Food Facts dan Mozilla Fenix sejak Maret. Saya pengguna Linux selama 3+ tahun terakhir dan telah menggunakan perintah terminal sejak itu.

Alat bantu dokumentasi dan bahasa yang telah saya gunakan adalah Sphinx, {i>Read the docs,<i} Markdown. Saya menyukai ide ini dan ingin mengerjakannya karena saya memiliki pengalaman yang relevan. Saya ingin menggunakan pengetahuan dan keterampilan saya untuk berkontribusi pada DIPY. Saya memiliki pengalaman di bidang pemrosesan gambar digital, computer vision, machine learning. Ini akan membantu saya untuk lebih memahami {i>neuroimaging<i} dan membuat dokumentasi. Saya memiliki banyak pengalaman di bidang medis. Saya mengembangkan situs 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 meninjau dokumentasi DIPY dan menemukan beberapa kekurangan dalam dokumentasinya. Ada beberapa celah dalam dokumentasi yang ingin saya perbaiki. Status Dokumentasi Saat Ini: Dokumentasi tidak memiliki struktur dan desain khusus Ini bisa merepotkan dan memakan waktu terutama bagi pengguna baru untuk menavigasi Pengguna mungkin kesulitan mendapatkan informasi dari panduan Konten dokumentasi perlu diperbaiki Sebagai pengguna baru, saya merasa sulit untuk mengakses panduan pengguna dan panduan pengembang. Dokumentasi perlu dibentuk ulang sedemikian rupa sehingga informasi yang diperlukan oleh pengguna harus mudah diakses Dokumentasi tidak memiliki konsistensi

Saya berencana melakukan hal berikut:

Menentukan struktur dan template spesifik untuk dokumentasi Membuat ulang dokumentasi sehingga pengguna dapat dengan mudah menavigasi dan menemukan informasi yang diperlukan Membuat roadmap atau daftar item kerja 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 dokumentasi teks yang baru) Menambahkan gambar non-tekstual

Panduan Pengguna:

Untuk panduan pengguna, saya akan fokus pada penggunaan bahasa sederhana dan sederhana 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 memberikan pengalaman pengguna yang lebih baik. Saya juga akan fokus pada penggunaan konten visual, termasuk gambar, screenshot beranotasi, grafik, dan video, yang dengan cepat menunjukkan kepada pengguna cara kerja sistem. Dokumentasi yang baik membutuhkan hierarki {i>heading<i} dan {i>subheading<i} yang memungkinkan pengguna mengetahui apa yang akan ditunjukkan oleh setiap bagian. Dan hierarki itu harus mengikuti alur logis yang membantu pengguna belajar menggunakan sistem dengan cara yang paling berguna. Salah satu tujuan utama proyek ini adalah membuat konten yang mudah diakses. Semua dokumen dan panduan akan mematuhi gaya yang konsisten. Menggunakan {i>font<i} yang konsisten dan warna yang saling melengkapi di beberapa dokumen adalah suatu keharusan. Saya akan memastikan bahwa pengguna memiliki akses ke lebih banyak sumber daya organisasi tentang cara agar sistem berhasil.

Panduan Developer:

Panduan developer mencakup panduan lengkap dan materi referensi untuk membantu developer memberikan kontribusi ke kode sumber DIPY. Artikel ini berupaya menjabarkan berbagai opsi yang tersedia untuk Anda, sehingga Anda dapat menggunakan pendekatan yang tepat, tergantung pada apa yang ingin Anda capai. Panduan pengembangan ini perlu dibentuk ulang dan direstrukturisasi. Saya akan menulis ulang isi panduan developer. Membuat dependensi, panduan kontribusi, panduan gaya, konvensi coding, panduan dokumentasi, menginstal lingkungan pengembangan, proses debug, panduan pengujian, dan hal-hal terkait akan disertakan dan dibuat mudah diakses oleh developer. Ketika kontributor baru yang bersemangat segera menuju proyek Anda untuk memberikan kontribusi {i>open-source<i} pertama mereka, mereka mengandalkan panduan yang berkontribusi sebagai panduan mereka. Dengan demikian, panduan ini mudah dibaca, menyeluruh, dan ramah. Panduan berkontribusi adalah dokumen bermanfaat yang mengkomunikasikan bagaimana orang dapat berkontribusi pada proyek {i>open-source<i}. Berkontribusi pada project harus dilakukan semudah dan setransparan mungkin bagi pengguna, baik itu: Mengirimkan perbaikan Melaporkan bug Menjadi pengelola Membahas status kode saat ini Mengajukan fitur baru

TEMPLATE

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

Berkontribusi ke DIPY

  • Catatan Selamat Datang

TOC

Kode Etik

  • Standar Kami
  • Contoh perilaku yang berkontribusi pada terciptanya lingkungan positif
  • Contoh perilaku yang tidak dapat diterima oleh peserta
  • Tanggung Jawab Kami
  • Tanggung jawab pengelola proyek
  • Cakupan

Cakupan Kode Etik

Apa yang perlu saya ketahui untuk membantu?

Jika Anda ingin membantu memberikan kontribusi kode, project kami menggunakan [masukkan daftar bahasa pemrograman, framework, atau alat yang digunakan project Anda]. Jika Anda belum siap untuk memberikan kontribusi kode, tidak masalah. Anda juga dapat melihat masalah dokumentasi [link ke label dokumen atau tag di issue tracker Anda] atau masalah desain yang kami miliki [link ke label desain atau tag pada issue tracker jika project Anda melacak masalah desain]. Jika Anda tertarik untuk memberikan kontribusi kode dan ingin mempelajari lebih lanjut teknologi yang kami gunakan, lihat daftar di bawah ini. Sertakan daftar berbutir referensi (tutorial, video, buku) yang dapat digunakan kontributor baru untuk mempelajari hal yang perlu diketahui pengguna agar dapat 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 Mengirimkan Laporan Bug
  • Bagaimana Cara Mengirim Laporan Bug (Baik)?

Cara mengirimkan perubahan

  • Protokol permintaan pull
  • Respons dari tim
  • Kecepatan respons

Cara meminta peningkatan

  • Sebelum Mengirimkan Saran peningkatan
  • Bagaimana Cara Mengirimkan Saran Peningkatan (Baik)?

Kontribusi kode pertama Anda

  • Masalah Pemula
  • Bantuan menginginkan masalah #### Pull Request
  • Proses pembuatan permintaan pull
  • Pastikan semua pemeriksaan status lulus.

Bagaimana jika pemeriksaan status gagal?

  • Ujian Menulis
  • Cakupan Tes

Panduan Gaya

  • Pesan commit Git
  • Gaya standar

Dukungan

Jika Anda mengalami masalah, 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 menjelaskan tentang lisensi proyek.

Komitmen waktu dan komunikasi:

Saya akan memberikan 45+ jam seminggu, tetapi jika terjadi kecelakaan, saya akan memberikan kompensasi pada jam-jam tersebut pada akhir pekan. Selama periode ikatan komunitas, saya akan membahas sarana komunikasi dan akan menyelesaikan pertemuan, sarana, dan waktu mingguan untuk pertemuan tersebut dengan mentor saya. Saya akan selalu memberikan informasi terbaru kepada mentor tentang pekerjaan saya; dan akan membagikan detail pekerjaan saya melalui email kepada mentor. Saya lebih suka menggunakan TeamViewer untuk berkomunikasi, karena alat ini mudah digunakan dengan banyak fitur seperti berbagi layar, dll.