Project BRL-CAD

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

Ringkasan project

Organisasi open source:
BRL-CAD
Penulis teknis:
sahibkaur
Nama project:
Panduan Pemula untuk BRL-CAD
Durasi project:
Durasi standar (3 bulan)

Project description

Panduan Pemula untuk BRL-CAD

Abstrak Project

Proyek ini bertujuan membuat dokumentasi yang dikhususkan untuk pengguna yang tidak hanya baru mengenal BRL-CAD, tetapi juga baru mengenal BRL-CAD.

Alasan project ini

Saat pertama kali mengunjungi situs BRL-CAD, karena saya baru mengenal open source dan BRL-CAD, saya kewalahan dengan banyaknya informasi sekaligus. Namun, jauh di lubuk hati, saya tahu ada banyak hal yang harus dipelajari di sini. Jadi, saya ingin membuat dokumentasi untuk pengguna baru seperti saya agar dapat memperoleh banyak manfaat dari komunitas ini dan merasa nyaman untuk memulai.

Sasaran

Project ini akan menargetkan pengguna baru. Jadi, berikut adalah beberapa poin yang ingin dicapai dalam dokumentasi saya: Untuk memastikan pengguna baru merasa nyaman: Karena dokumentasi ini tidak hanya ditujukan untuk pengguna baru yang baru mengenal BRL-CAD, tetapi juga yang baru mengenal BRL-CAD.

Untuk mencapai hal ini, saya akan:

  • Pastikan skor Flesch-Kincaid dokumen minimal di atas 50. Menurut metode Flesch-Kincaid, semakin tinggi skornya, semakin mudah bagian tersebut dipahami. Anda dapat memeriksa skor keterbacaannya secara online.
  • Gunakan daftar berbutir atau bernomor agar pembaca tidak bosan atau terganggu dengan paragraf yang panjang.
  • Gunakan paragraf dan kalimat yang lebih pendek karena memerlukan upaya mental yang relatif lebih besar untuk membaca dan memahami kalimat yang lebih panjang.
  • Gunakan subjudul untuk membagi teks. Dokumentasi yang terstruktur dengan baik: Dokumentasi yang terstruktur dengan baik berperan penting dalam memandu pengguna baru. Hal ini mencegah mereka tersesat dan, memberi tahu mereka ke mana mereka akan pergi dan apa yang mereka lakukan. Untuk mencapai hal ini, saya telah membuat peta pikiran kasar yang dapat membantu kami mendokumentasikan panduan pemula ini secara terorganisir.

Deskripsi Project

Project ini berfokus pada penulisan dokumentasi bagi pengguna baru untuk mendapatkan software ini.

Berikut adalah contoh cara saya membuat dokumentasi lebih deskriptif.

Pengantar Dasar: BRL-CAD (dibaca be-are-el-cad) adalah desain dengan bantuan komputer (CAD) pemodelan solid geometri padat konstruktif (CSG). Ini adalah sistem pemodelan solid open source lintas platform yang canggih untuk desain berbantuan komputer 3D dan visualisasi grafis. Tidak dapat memahaminya? Mari kita bahas secara mendetail. Open source: Software open source adalah software dengan kode sumber yang dapat diperiksa, dimodifikasi, dan ditingkatkan oleh siapa saja. BRL-CAD adalah software open source yang menyambut Anda untuk berkontribusi dan membuat BRL-CAD lebih baik dari sebelumnya. {i>Computer Aided Design<i} (CAD): Dengan kata sederhana, CAD adalah penggunaan program komputer untuk membuat dua atau tiga dimensi representasi grafis dari objek fisik. Sistem pemodelan solid: BRL-CAD berfokus pada CAD pemodelan solid. Pemodelan solid dibedakan dari bentuk pemodelan geometris lainnya dengan penekanan pada akurasi fisik, yang sepenuhnya mendeskripsikan ruang 3D. Alat ini menyimulasikan objek secara internal dan eksternal. Constructive Solid Geometry (CSG): CSG memungkinkan representasi model kompleks sebagai serangkaian operasi Boolean di antara primitif. Objek padat paling sederhana yang digunakan untuk representasi disebut primitif. Untuk memahami CSG pada tingkat dasar, buka di sini.

*Seperti yang disebutkan dalam deskripsi ide project: Dokumentasi minimal akan mencakup penginstalan dasar, deskripsi keseluruhan kemampuan, prinsip pemodelan BRL-CAD, penggunaan dasar alat utama, pemodelan, impor/ekspor, analisis, dan rendering.

Berikut adalah pengantar singkat tentang cara membahas setiap bagian dalam dokumentasi.

  • Penginstalan Dasar: Saya akan menambahkan tutorial langkah demi langkah untuk menginstal software BRL-CAD beserta screenshot yang diperlukan. Tutorial untuk pemula adalah tempat yang bagus bagi pengguna baru untuk memulai. Beberapa hal yang saya temukan tidak ada adalah:
  • Langkah-langkah tutorial untuk pemula ini tidak berbutir atau bernomor. Dengan tutorial langkah demi langkah yang dilengkapi screenshot di akhir setiap langkah, pengguna akan lebih tertarik untuk mengikuti tutorial.
  • Deskripsi kemampuan secara keseluruhan: Bagian ini akan berisi semua area tempat BRL-CAD memiliki kemampuan untuk menunjukkan keajaiban. Pendekatan diagram akan menjadi cara yang lebih baik untuk menarik perhatian ke bagian ini.
  • Prinsip pemodelan BRL-CAD: Bagian ini akan memerlukan lebih banyak penjelasan karena pengguna dapat lebih memahami BRL-CAD setelah mereka memahami prinsip pemodelan ini dengan baik.
  • Penggunaan dasar alat utama: Di bagian ini, kami akan memiliki tutorial terpisah tentang alat utama dan penggunaan dasarnya. Ini akan menjadi tutorial langkah demi langkah.
  • Ekspor/Impor: Pengguna akan mengetahui tentang Library Konversi Geometri. Salah satu penggunaan BRL-CAD yang paling umum adalah untuk mengonversi geometri dari satu format ke format lainnya. Di bagian ini, kita akan membahas pengonversi ekspor dan impor.
  • Rendering: Kita akan membahas dasar-dasar rendering dan kebutuhannya dalam software kami. Pengguna juga akan mengetahui cara merender gambar di BRL-CAD.

Selain itu, fokusnya juga pada poin-poin berikut:

  • Bagian awal dokumentasi akan memiliki pemahaman dasar tentang software ini.
  • Cara pengguna dapat terhubung dengan komunitas open source ini; link ke chat zulip BRL-CAD.
  • Pada tingkat abstrak, membuat dokumentasi sedikit lucu dan meminta pengguna baru untuk tidak berkecil hati dengan kata-kata besar. Saya menyukai pendekatan empati yang digunakan di halaman Utama wiki BRL-CAD.
  • Halaman ini akan berisi screenshot beberapa hal luar biasa yang dapat dilakukan pengguna menggunakan software ini.

Pencapaian

Juli (Periode Peninjauan Proposal)

  • Saya akan lebih memahami software dan dokumen wiki-nya sambil mempelajari tutorial yang ada.
  • Kami akan melakukan peningkatan pada dokumen yang ada.

1 Agustus - 7 Agustus (Ikatan komunitas)

  • Berdiskusi dengan mentor tentang project.
  • Meningkatkan kualitas detail project.
  • Buat perubahan yang diperlukan pada tonggak pencapaian (jika perlu).

8 Agustus - 14 Agustus

  • Pahami XML Docbook

15 Agustus - 21 Agustus

  • Menulis dokumentasi untuk “Pengantar Dasar BRL-CAD”
  • Menulis tutorial langkah demi langkah untuk “Penginstalan Dasar”

22 Agustus - 27 Agustus

  • Menjelajahi berbagai kemampuan BRL-CAD dan mencantumkannya beserta screenshot.
  • Jelaskan setiap fitur di halaman terpisah.

28 Agustus - 3 September

  • Terus kerjakan masing-masing dokumen untuk kemampuan.

4 September - 10 September

  • Menangani Prinsip Pemodelan.
  • Menjelaskan semua prinsip pemodelan.

11 September - 17 September

  • Mengerjakan Penggunaan Dasar pada alat-alat Utama.
  • Pilih ide untuk mendokumentasikan penggunaan dasar setiap alat.

18 September - 24 September

  • Mendokumentasikan penggunaan setiap alat.

25 September - 1 Oktober

  • Kerjakan Pemodelan untuk membuat model yang solid untuk tutorial dan tulis drafnya.

2 Oktober - 8 Oktober

  • Tingkatkan kualitas draf pemodelan.

2 Oktober - 8 Oktober

  • Mempelajari pengonversi ekspor dan impor.

9 Oktober - 15 Oktober

  • Menyiapkan dokumen ekspor dan impor.
  • Mulai lakukan rendering.

16 Oktober - 22 Oktober

  • Mendokumentasikan tutorial rendering.

23 Oktober - 29 Oktober

  • Meninjau semua dokumen.

30 Oktober - 5 November

  • Bekerja dengan XML Docbook

6 November - 12 November

  • Minta ulasan dari mentor dan anggota komunitas lainnya, lalu kerjakan perubahannya.
  • Berdiskusi dengan mentor dan membuat perubahan akhir.

12 November - 22 November

  • Proses diskusi dan perubahan.
  • Memberikan sentuhan akhir pada dokumentasi.

Tentang saya

Saya telah menyukai menulis sejak masa sekolah. Saya akan pulang dari sekolah dan menulis semua tentang hari saya; apa yang membuat hari saya lebih baik atau lebih buruk. Saya selalu ingin menuliskan kesalahan yang saya buat dan cara memperbaikinya.

Selama pelatihan saya sebagai desainer web, kami diminta untuk menuliskan apa yang kita pelajari setiap hari. Saya akan mendokumentasikan beberapa masalah yang saya hadapi dan solusinya.

Sebagai pribadi, saya selalu berusaha membantu orang lain. Selama sekolah dan kuliah, saya akan menjelaskan beberapa topik kepada teman-teman setelah memahami topik tersebut sendiri. Mengambil bagian dalam GSoD adalah langkah luar biasa di mana saya, sebagai seorang penulis, dapat berkontribusi untuk menjadikan komunitas open-source ini lebih menarik dan bermanfaat bagi pengguna baru di seluruh dunia.