Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- HPX
- Penulis teknis:
- rstobaugh
- Nama proyek:
- Mengedit & Merampingkan Dokumentasi HPX yang Ada
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Proposal saya adalah untuk mengedit dan merampingkan isi dokumentasi HPX yang ada. Proposal saya adalah untuk proyek jangka waktu standar (tiga bulan) yang berfokus pada revisi dua bab dari manual grup STE||AR: ""HPX Build System and Launching"" (1) dan ""Mengonfigurasi Aplikasi HPX"" (2).
Bab tentang ""HPX Build System and Launching"" memiliki beberapa kesalahan tata bahasa dan juga berisi kata-kata yang membingungkan dan kapitalisasi istilah yang tidak konsisten seperti “CMake”. Selain itu, bab ini berisi informasi berulang, yang rencananya akan saya atur ulang, gabungkan, dan pangkas sesuai kebutuhan. Meskipun bab tentang ""Mengonfigurasi Aplikasi HPX"" juga berisi beberapa kesalahan gramatikal yang perlu ditangani, perhatian utama saya untuk bab ini adalah keramahan pengguna. Bab ini memiliki tiga masalah desain utama yang akan saya bahas:
Beberapa judul tersembunyi di dalam teks, sehingga sulit untuk membaca sekilas di seluruh bab. Saat ini, pengguna perlu membaca manual dengan cermat untuk memahami tujuan setiap tabel. Ini bukanlah cara sebagian besar pengguna berinteraksi dengan panduan petunjuk, terutama jika mereka sudah pernah membaca konten sebelumnya. Sebaliknya, saya berencana untuk memastikan setiap tabel memiliki {i>heading<i} yang jelas dan berbeda, yang mudah dilihat jika pengguna menggulir teks.
Saat mencantumkan berbagai properti di bawah judul tertentu, properti tersebut tidak mengikuti urutan yang logis. Meskipun properti dikelompokkan bersama dalam tema umum, tidak ada sub-pengelompokan, yang membuat informasi terasa tersebar. Misalnya, pengguna mungkin menemukan beberapa properti yang menangani lokalitas, beberapa yang menangani subjek lain, lalu properti lain yang menangani lokalitas. Kurangnya struktur internal di bawah judul ini menyulitkan untuk menemukan semua informasi pada subtopik tertentu. Oleh karena itu, saya berencana untuk mengatur ulang beberapa diagram untuk mengelompokkan informasi serupa secara lebih jelas di bawah setiap judul.
Pengguna dipaksa menavigasi bolak-balik di antara bagian (atau membuka panduan dalam dua tab terpisah) untuk sepenuhnya memahami petunjuk tertentu. Ada poin-poin di mana bab mengarahkan pengguna ke satu kalimat dalam bagian sebelumnya dengan cara yang memaksa pembaca untuk menggulir ke atas atau mengikuti {i>hyperlink<i} untuk memahami instruksi yang tepat, karena panduan menggunakan bahasa yang tidak jelas seperti "langkah ini dibentuk setelah langkah 11" di bagian sebelumnya. Meskipun metode ini menghilangkan pengulangan, metode ini akan mempersulit pemahaman instruksi karena ini adalah tugas yang perlu disusun dalam urutan tertentu. Sebagai gantinya, saya mengusulkan untuk menyertakan kata-kata yang lebih spesifik agar pengguna tidak perlu mengganggu proses membaca mereka dengan beralih antar bagian atau dokumen.
Jika saya menyelesaikan bagian ini sebelum rentang waktu standar selesai, saya juga ingin membersihkan halaman “Mengapa HPX?” (3) di bawah Dokumentasi Pengguna grup STE||AR. Halaman ini berisi konten pengantar berulang, yang saya harap dapat digabungkan dan mengandung ketidakkonsistenan dalam kapitalisasi (terutama jargon) dan suara, yang memberikan nuansa yang terpisah. Tujuan saya adalah membuat pengantar yang lebih terpadu dan konsisten tentang pekerjaan grup STE||AR.