Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Kaleidoscope
- {i>Technical writer <i}(Penulis teknis):
- techwriterjill
- Nama project:
- Mengembangkan dan meningkatkan dokumentasi Kaleidoscope
- Durasi project:
- Durasi standar (3 bulan)
Project description
Sebagai seorang penulis, saya sangat tertarik dengan proyek ini. Saat ini saya menggunakan keyboard ergonomis yang tidak memiliki kemampuan Kaleidoscope Model 01, tetapi pengetahuan saya tentang tata letak keyboard terpisah/tented akan membantu saya pada tahap awal saat menguji dan menjelajahi fungsi firmware. Pengalaman saya sebagai pengguna produk serupa juga akan membantu saya mengidentifikasi fitur dan dokumentasi produk yang berguna bagi sesama pengguna.
Saya berpengalaman dalam mendokumentasikan pemasangan dan konfigurasi produk yang kompleks dan sangat menikmati jenis pekerjaan ini. Saya juga suka ""melakukannya sendiri"" (yang akan sangat literal dalam hal ini) dengan produk dan proses untuk memahaminya, agar dapat menulis tentangnya. Saya yakin hal ini memungkinkan saya menghasilkan dokumentasi berkualitas yang bernilai nyata bagi pengguna.
Sebelum menjadi penulis teknis khusus, saya bekerja sebagai analis dukungan yang telah memberikan keterampilan berharga yang akan saya gunakan untuk proyek ini, seperti menyusun kode, menguji, menyelidiki, dan mereplikasi masalah.
Saya telah melakukan kontak awal dengan Jesse dan Gergely di Kaleidoscope dan kami telah membuat rencana sementara bahwa, jika diterima, saya dapat mengerjakan project berikut yang telah mereka identifikasi sebagai yang paling berharga bagi pengguna mereka:
- Mendokumentasikan plugin hardware
- Mendokumentasikan cara menulis makro untuk pengguna baru
- Menulis ringkasan plugin yang tersedia
Saya bekerja penuh waktu sehingga saya dapat berkomitmen sekitar 10 jam per minggu selama periode Musim Dokumen. Dengan begitu, saya dapat menyelesaikan lebih banyak project kecil selain yang telah disebutkan di atas. Saat meneliti Kaleidoscope, saya melihat bahwa satu-satunya deskripsi produk yang mudah digunakan ada di halaman Kickstarter. Proyek crowdfunding awal berakhir pada tahun 2015, jadi saya pikir diperlukan situs yang berfokus pada pengguna. Saya bukan developer web, tetapi saya akan dengan senang hati memberikan kontribusi ide dan teks untuk situs, jika Kaleidoscope tertarik untuk melakukannya.
Jesse dan Gergely telah menawarkan untuk mengirim keyboard kepada penulis yang berhasil dan saya pikir hal ini akan berperan penting dalam kesuksesan project ini.
Saya yakin bahwa keterampilan dan pengalaman saya menjadikan saya kandidat yang ideal untuk project ini dan saya menantikan kabar dari Anda.