Project BRL-CAD

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

Ringkasan proyek

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

Project description

Panduan BRL-CAD untuk Pemula

Abstrak Project

Project ini bertujuan untuk membuat dokumentasi khusus bagi pengguna yang tidak hanya baru mengenal BRL-CAD tetapi juga baru mengenal open source.

Mengapa proyek 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 dalam hati, saya tahu ada banyak hal yang harus dipelajari di sini. Jadi, saya ingin membuat dokumentasi bagi pengguna baru seperti saya untuk mendapatkan banyak manfaat dari komunitas ini dan merasa mudah untuk memulainya.

Gol

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

Untuk mencapai hal ini, saya akan:

  • Pastikan untuk menjaga skor Flesch-Kincaid dokumen setidaknya di atas 50. Menurut metode Flesch-Kincaid, semakin tinggi skornya, semakin mudah memahami suatu bagian. Anda dapat memeriksa skor keterbacaannya secara online.
  • Gunakan daftar berbutir atau bernomor sehingga pembaca tidak bosan atau terganggu oleh paragraf yang panjang.
  • Gunakan paragraf dan kalimat yang lebih pendek karena memerlukan upaya yang relatif lebih mental untuk membaca dan memahami kalimat yang lebih panjang.
  • Gunakan subjudul untuk memisahkan teks. Dokumentasi yang terstruktur dengan baik: Dokumentasi yang terstruktur dengan baik memainkan peran penting dalam memandu pengguna baru. Hal ini mencegah mereka tersesat dan, memberi tahu mereka ke mana arah tujuan mereka 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

Proyek ini berfokus pada penulisan dokumentasi bagi pengguna baru untuk mendapatkan perangkat lunak ini.

Diberikan di bawah ini adalah contoh bagaimana saya ingin membuat dokumentasi lebih deskriptif.

Pengantar Dasar: BRL-CAD (diucapkan be-are-el-cad) adalah desain berbantuan komputer (CAD) pemodelan solid geometry (CSG) yang konstruktif. Ini adalah sistem pemodelan solid lintas platform yang andal untuk desain berbantuan komputer dan visualisasi grafis 3D. 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. Dengan aplikasi BRL-CAD, Anda dapat berkontribusi dan membuat BRL-CAD lebih baik dari sebelumnya. {i>Computer Aided Design<i} (CAD): Secara sederhana, CAD adalah penggunaan program komputer untuk membuat representasi grafis dua atau tiga dimensi dari objek fisik. Sistem pemodelan solid: BRL-CAD berfokus pada pemodelan solid CAD. Pemodelan solid berbeda dari bentuk pemodelan geometris lainnya karena menekankan pada akurasi secara fisik, yang sepenuhnya menggambarkan ruang 3D. Model ini menyimulasikan objek baik secara internal maupun eksternal. Geometri Padat Konstruktif (CSG): CSG memungkinkan untuk merepresentasikan model kompleks sebagai serangkaian operasi Boolean di antara primitif. Objek solid 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 ini minimal akan mencakup penginstalan dasar, deskripsi kemampuan secara keseluruhan, prinsip pemodelan BRL-CAD, penggunaan dasar alat utama, pemodelan, impor/ekspor, analisis, dan rendering.

Pengantar singkat tentang bagaimana saya akan 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 untuk memulai pengguna baru. Beberapa hal yang saya temukan yang hilang adalah:
  • Langkah-langkah tutorial pemula ini tidak berbutir atau diberi nomor. Memiliki tutorial langkah demi langkah dengan screenshot di akhir setiap langkah membuat pengguna lebih mungkin untuk terpikat dengan tutorial.
  • Deskripsi keseluruhan kemampuan: Bagian ini akan berisi semua area yang kemampuan BRL-CAD untuk menampilkan keajaiban. Pendekatan diagram akan menjadi cara yang lebih baik untuk menarik perhatian terhadap bagian ini.
  • Prinsip pemodelan BRL-CAD: Bagian ini akan memerlukan penjelasan lebih lanjut karena pengguna dapat lebih memahami BRL-CAD setelah mereka memahami prinsip-prinsip pemodelan ini dengan lebih baik.
  • Penggunaan dasar alat utama: Di bawah ini, kami akan menyajikan tutorial terpisah tentang alat utama dan penggunaan dasarnya. Video 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 mengonversi geometri dari satu format ke format lainnya. Di bagian ini, kami membahas pengonversi ekspor dan impor.
  • Rendering: Kami akan membahas dasar-dasar rendering dan kebutuhannya dalam software kami. Pengguna juga dapat mengetahui cara merender gambar dalam BRL-CAD.

Selain itu, fokusnya juga pada poin-poin berikut:

  • Pada awal dokumentasi, Anda akan memiliki pemahaman dasar tentang apa yang dimaksud dengan perangkat lunak 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 karena kata-kata yang kasar. Saya menyukai pendekatan berempati yang digunakan di Halaman utama wiki BRL-CAD.
  • {i>Software<i} ini akan memiliki {i>screenshot<i} dari beberapa hal menakjubkan yang dapat dilakukan pengguna dengan menggunakan perangkat lunak ini.

Pencapaian

Juli (Periode Peninjauan Proposal)

  • Saya akan membuat diri saya lebih akrab dengan perangkat lunak dan dokumen {i>wiki<i}-nya saat mempelajari tutorial yang ada.
  • Saya akan melakukan peningkatan pada dokumen yang ada.

1 Agustus - 7 Agustus (Ikatan komunitas)

  • Berdiskusi dengan para mentor tentang proyek ini.
  • Menyempurnakan detail proyek.
  • Buat perubahan yang diperlukan dalam {i>milestone<i} (jika perlu).

8—14 Agustus

  • Memahami 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

  • Jelajahi berbagai kemampuan BRL-CAD dan buat daftarnya bersama dengan screenshot.
  • Jelaskan masing-masing fitur di halaman terpisah.

28 Agustus - 3 September

  • Terus kerjakan masing-masing dokumen untuk kapabilitas.

4 September - 10 September

  • Mengerjakan Prinsip-Prinsip Pemodelan.
  • Menjelaskan semua prinsip pemodelan.

11 September - 17 September

  • Memahami Penggunaan Dasar Alat Utama.
  • Buat daftar ide singkat untuk mendokumentasikan penggunaan dasar setiap alat.

18 September - 24 September

  • Mendokumentasikan penggunaan setiap alat.

25 September - 1 Oktober

  • Mengerjakan Pemodelan untuk membuat model yang solid untuk tutorial dan menulis drafnya.

2 Oktober - 8 Oktober

  • Menyempurnakan draf pemodelan.

2 Oktober - 8 Oktober

  • Mempelajari pengonversi ekspor dan impor.

9 Oktober - 15 Oktober

  • Siapkan ekspor dan impor dokumen.
  • Mulai mengerjakan rendering.

16 Oktober - 22 Oktober

  • Mendokumentasikan tutorial rendering.

23 Oktober - 29 Oktober

  • Meninjau semua dokumen.

30 Oktober - 5 November

  • Mengerjakan XML Docbook

6 November - 12 November

  • Mintalah ulasan dari mentor dan anggota komunitas lainnya, kemudian kerjakan perubahan tersebut.
  • Berdiskusi dengan mentor dan membuat perubahan akhir.

12 November - 22 November

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

Tentang saya

Saya sudah memiliki jurusan menulis sejak masa sekolah. Saya pulang sekolah dan menuliskan semua hal tentang keseharian saya. Apa yang membuat hari saya lebih baik atau lebih buruk. Saya selalu ingin menuliskan kesalahan yang saya buat dan bagaimana cara memperbaikinya.

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

Sebagai pribadi, saya selalu berusaha sebaik mungkin untuk membantu orang lain. Selama masa sekolah dan kuliah, saya akan menjelaskan beberapa topik kepada teman-teman saya setelah memahami topik tersebut sendiri. Ikut serta dalam GSoD merupakan langkah luar biasa yang memungkinkan saya, sebagai penulis, dapat berkontribusi dalam menjadikan komunitas open-source ini lebih menarik dan bermanfaat bagi pengguna baru di seluruh dunia.