Project BRL-CAD

Halaman ini berisi detail proyek penulisan teknis yang diterima untuk Google Season of 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 Proyek

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

Mengapa proyek ini

Ketika pertama kali mengunjungi situs BRL-CAD, karena saya baru mengenal open-source dan BRL-CAD, saya kewalahan dengan banyaknya informasi pada saat itu juga. Namun, jauh di dalam, saya tahu ada banyak hal yang harus dipelajari di sini. Jadi, saya ingin membuat dokumentasi untuk pengguna baru seperti saya agar bisa mendapatkan banyak manfaat dari komunitas ini dan merasa nyaman untuk memulainya.

Tujuan

Proyek 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 skor Flesch-Kincaid dokumen tidak lebih dari 50. Menurut metode Flesch-Kincaid, semakin tinggi skornya, semakin mudah bagian tersebut dipahami. Anda dapat memeriksa skor keterbacaan 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 membutuhkan 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 arahnya dan apa yang akan mereka lakukan. Untuk mencapai hal ini, saya telah membuat peta pikiran kasar yang dapat membantu kami mendokumentasikan panduan pemula ini secara teratur.

Deskripsi Project

Proyek ini berfokus pada penulisan dokumentasi bagi pengguna baru yang ingin menggunakan perangkat lunak ini.

Di bawah ini adalah contoh bagaimana saya bermaksud membuat dokumentasi lebih deskriptif.

Pengantar Dasar: BRL-CAD (diucapkan be-are-el-cad) adalah solid geometry solid geometry (CSG) pemodelan solid yang didukung computer-aided design (CAD). Ini adalah sistem pemodelan solid lintas platform, open-source 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 diperbaiki oleh siapa saja. BRL-CAD menjadi software open-source menyambut Anda untuk berkontribusi dan membuat BRL-CAD lebih baik dari sebelumnya! {i>Computer Aided Design<i} (CAD): Dengan kata-kata sederhana, CAD adalah penggunaan program komputer untuk membuat representasi grafis dua atau tiga dimensi dari objek fisik. Sistem pemodelan padat: BRL-CAD berfokus pada CAD pemodelan solid. Pemodelan solid dibedakan dari bentuk pemodelan geometri lainnya dengan penekanan pada akurat secara fisik, yang sepenuhnya menggambarkan ruang 3D. Class ini menyimulasikan objek baik secara internal maupun eksternal. Constructive Solid Geometry (CSG): CSG memungkinkan untuk merepresentasikan model kompleks sebagai serangkaian operasi Boolean antar-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 minimal akan mencakup penginstalan dasar, deskripsi keseluruhan kemampuan, prinsip-prinsip pemodelan BRL-CAD, penggunaan dasar alat utama, pemodelan, impor/ekspor, analisis, dan rendering.

Daftar adalah 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 bagi pengguna baru untuk memulai. Beberapa hal yang saya temukan hilang adalah:
  • Langkah-langkah dalam tutorial pemula ini tidak berbutir atau bernomor. Adanya tutorial langkah demi langkah dengan screenshot di akhir setiap langkah akan membuat pengguna lebih mungkin untuk terpikat dengan tutorial tersebut.
  • Deskripsi keseluruhan kemampuan: Bagian ini akan berisi semua area di mana BRL-CAD memiliki kemampuan 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 lebih banyak penjelasan 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 menyediakan 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 paling umum BRL-CAD adalah untuk mengonversi geometri dari satu format ke format lainnya. Di bagian ini, kita akan membahas pelaku konversi ekspor dan impor.
  • Rendering: Kita akan membahas dasar-dasar rendering dan kebutuhannya dalam software. Pengguna juga akan mengetahui cara merender gambar dalam BRL-CAD.

Selain itu, fokusnya juga pada poin-poin berikut:

  • Bagian awal dokumentasi 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 putus asa dengan kata-kata besar. Saya menyukai pendekatan berempati yang digunakan dalam Halaman utama wiki BRL-CAD.
  • Sistem 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 familier dengan software dan dokumen wikinya sambil melihat tutorial yang ada.
  • Saya akan melakukan peningkatan dalam dokumen yang ada.

1 Agustus - 7 Agustus (Ikatan komunitas)

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

8 Agustus - 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 mencantumkannya bersama dengan screenshot.
  • Jelaskan fitur individual pada halaman terpisah.

28 Agustus - 3 September

  • Terus kerjakan masing-masing dokumen untuk mengetahui kemampuannya.

4 September - 10 September

  • Mengerjakan Prinsip Pemodelan.
  • Menjelaskan semua prinsip pemodelan.

11 September - 17 September

  • Mengerjakan Penggunaan Dasar berbagai alat Utama.
  • Buat daftar pendek ide untuk mendokumentasikan penggunaan dasar dari 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 draf bersamanya.

2 Oktober - 8 Oktober

  • Sempurnakan draf pemodelan.

2 Oktober - 8 Oktober

  • Mempelajari pelaku konversi ekspor dan impor.

9 Oktober - 15 Oktober

  • Siapkan dokumen ekspor dan impor.
  • Mulai melakukan 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 dan lakukan perubahan.
  • Berdiskusi dengan mentor dan membuat perubahan akhir.

12 November - 22 November

  • Berdiskusi dan melakukan perubahan.
  • Memberikan sentuhan terakhir pada dokumentasi.

Tentangku

Saya telah menekuni dunia menulis sejak bersekolah. Setelah pulang sekolah, saya biasanya menulis semua cerita tentang keseharian saya, apa yang membuat hari saya jadi 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 kita pelajari setiap hari. Saya akan mendokumentasikan beberapa masalah yang saya hadapi dan solusinya.

Sebagai pribadi, saya selalu berusaha sebaik-baiknya 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 adalah langkah luar biasa yang membuat saya, sebagai penulis, dapat berkontribusi dalam membuat komunitas open-source ini lebih menarik dan bermanfaat bagi pengguna baru di seluruh dunia.