Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- CircuitVerse
- Penulis teknis:
- Pragati
- Nama proyek:
- Dokumentasi dan Panduan Pengguna
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Setelah melakukan analisis mendalam tentang audiens dan dokumentasi pengguna yang tersedia saat ini, saya mengusulkan tugas dokumentasi di bawah ini:
1) Tambahkan tutorial video untuk mendemonstrasikan alur kerja yang populer dan meningkatkan pengalaman orientasi. Video akan menguraikan satu konsep. Video akan memberikan arahan saat melakukan tindakan tersebut di layar.
Link tutorial video contoh untuk menggunakan Alat Analisis Kombinasi dapat ditemukan di sini. https://www.youtube.com/watch?v=7FkeqBYcd1w Catatan 1: Meskipun video ini menampilkan contoh konten yang sudah ada, video ini dimaksudkan untuk menunjukkan gaya penggunaan anotasi untuk membuat gaya video yang konsisten. Catatan 2: Ketika saya mulai bekerja di CircuitVerse, saya akan membeli lisensi untuk software tersebut dan produk akhirnya tidak akan menyertakan watermark.
Topik yang disarankan untuk alur kerja tutorial video: --Memulai CircuitVerse: Tonton video tutorial ini untuk melakukan tur singkat CircuitVerse --Menggunakan Alat Analisis Kombinasional: Tonton video tutorial ini untuk mempelajari cara membuat sirkuit menggunakan data tabel kebenaran. --Mengekspor Gambar Resolusi Tinggi: Tonton video tutorial ini untuk mempelajari cara mengekspor gambar resolusi tinggi sirkuit Anda dalam berbagai format --Menggunakan Subsirkuit untuk Desain Terstruktur: Tonton video tutorial berikut untuk mempelajari cara membuat sub sirkuit guna menyederhanakan struktur rangkaian kompleks --Menggunakan Alat Konverter Hex-Bin-Des: Tonton video tutorial ini untuk mempelajari cara menggunakan alat desain dan Pengonversi Hex-Bin-Des. --Memvisualisasikan diagram pengaturan waktu sirkuit untuk sirkuit tertentu: Tonton tutorial video ini untuk mempelajari cara pengguna memvisualisasikan diagram pengaturan waktu sirkuit untuk sirkuit tertentu.
Beberapa video tutorial dapat ditautkan di seluruh halaman web dan dokumentasi pengguna.
2) Membuat halaman landing tutorial untuk memberikan gambaran singkat tentang platform CircuitVerse serta memberikan tampilan grafis dari berbagai alur kerja. Pengguna akan mengakses halaman landing tutorial di situs GitHub Circuitverse yang akan memberikan garis besar singkat tentang berbagai tutorial yang ditawarkan untuk alur kerja konten yang berbeda. Hal ini memberi pengguna kemampuan untuk melihat dan memilih tutorial yang berbeda sesuai kebutuhan mereka. Di bawah ini adalah contoh kasar dari struktur halaman landing tutorial.
3) Buat tutorial langkah demi langkah untuk mengedukasi pengguna tentang cara menggunakan alat untuk mempelajari dan menganalisis perilaku sirkuit dasar dan kompleks–ajarkan alat dengan bermain-main dengan alat tersebut. Dengan merujuk pada proyek unggulan CircuitVerse, saya mengusulkan untuk menambahkan setidaknya 5 tutorial bagi pengguna tingkat pemula dan menengah untuk meningkatkan pengalaman orientasi. Menggambarkan alur kerja yang lengkap, setiap tutorial akan memberikan pengenalan tutorial, diikuti dengan proses desain, daftar komponen, petunjuk langkah demi langkah, dan latihan praktik. Untuk alur kerja yang kompleks, video akan membahas suatu bagian individual dari keseluruhan konsep.
Kunjungi tautan ini untuk melihat contoh tutorial: Membuat Decoder Tujuh Segmen: https://pragatijain.github.io/circuitverse/index.html
Beberapa topiknya meliputi: --Membuat layar LED bergulir --Pelajari cara kerja ripple membawa adder --Bagian 1A: Menganalisis pembanding magnitudo 4-bit --Bagian 1B: Membangun kalkulator heksadesimal --Menganalisis implementasi finite state machine (FSM)
4) Merevisi struktur navigasi bilah sisi untuk meningkatkan konsistensi, keterbacaan, dan kekohesif.
{i>Project Tools<i} 1) Camtasia untuk tutorial video. Saya telah menggunakan versi uji coba untuk membuat video sampel. Ketika saya mulai bekerja di CircuitVerse, saya akan membeli lisensi untuk software tersebut dan produk akhir tidak akan menyertakan watermark. 2) Dokumen Google untuk menulis panduan saya yang nanti akan saya perbarui di GitHub untuk di-host di repositori CircuitVerse. 3) Markup Wiki dan HTML untuk mengelola konten saya di GitHub.
Linimasa Sebelum 16 Agustus Beri kontribusi kepada organisasi di GitHub.
Ikatan komunitas (17 Agustus - 13 September) Siapkan saluran dan waktu komunikasi (karena perbedaan waktu). Sempurnakan tujuan saya dan tetapkan ekspektasi dari kedua sisi. Pelajari lebih lanjut komunitas dan produk. Diskusikan dan selesaikan struktur dokumentasi yang diusulkan dengan mentor dan anggota organisasi lainnya.
Periode dokumentasi Project ini akan mengikuti panduan proyek dengan durasi standar (total 11 minggu, dari 14/9/2020 hingga 30/11/2020). Saya akan menghabiskan sekitar 20 jam seminggu untuk menyelesaikan tujuan yang diuraikan di bawah ini. Selain tujuan tersebut, saya akan mengambil bagian dalam pertemuan mentor dan komunikasi selama waktu ini, jika diperlukan. Saya akan bekerja sama dengan para mentor untuk menentukan waktu terbaik. Catatan: Linimasa ini fleksibel dan menyadari fakta bahwa kebutuhan organisasi dapat berubah. Jangka waktu yang besar memungkinkan fleksibilitas dan kemampuan untuk beralih fokus, sesuai kebutuhan.
Minggu ke-1: Tinjau tonggak pencapaian yang diidentifikasi dan sempurnakan repositori Fork CircuitVerse dan download ke komputer saya Diskusikan dengan mentor tentang gaya video, juga kembangkan template layar pembuka video, musik pengisi apa pun untuk judul dan layar akhir, dan informasi tambahan yang harus disertakan. Tinjau topik tutorial video dan dapatkan persetujuannya Identifikasi topik tutorial dan dapatkan persetujuan. Tinjau struktur navigasi sidebar dan dapatkan persetujuan
Minggu ke-2: Membuat template tutorial dan mendapatkan persetujuan mentor Membuat halaman landing tutorial untuk menghosting tutorial
Minggu ke-3, 4, 5: Tambahkan tutorial video untuk mendemonstrasikan alur kerja simulator yang berbeda
Minggu 6, 7, 8, 9: Buat tutorial untuk sirkuit sederhana dan kompleks yang berbeda
Minggu ke-10: Mengubah struktur navigasi sidebar untuk konsistensi guna meningkatkan pengalaman orientasi pengguna
Minggu ke-11: Memeriksa tata bahasa pekerjaan saya untuk menemukan {i>typo<i} dan {i>error<i}.
Contoh Pekerjaan Sirkuit yang Relevan
*Kunjungi tautan ini untuk melihat contoh tutorial: Membuat Dekoder Tujuh Segmen. : https://pragatijain.github.io/circuitverse/index.html
*Contoh link tutorial video untuk menggunakan Alat Analisis Kombinasi dapat ditemukan di sini. https://www.youtube.com/watch?v=7FkeqBYcd1w Catatan 1: Meskipun video ini menunjukkan konten yang sudah ada, video ini dimaksudkan untuk menunjukkan gaya penggunaan anotasi untuk membuat gaya video yang konsisten. Catatan 2: Ketika saya mulai bekerja untuk GDevelop, saya akan membeli lisensi untuk software tersebut dan produk akhir tidak akan menyertakan watermark.
*Halaman Landing Tutorial CicuitVerse https://docs.google.com/document/d/1sBKS2cq76zRHDGgA2Lbf7isSisRK_ELLSPsg-7atCAI/edit#
*Lihat proposal lengkap sebagai dokumen google: https://docs.google.com/document/d/1vzYyDnX6mFXXByrcwVsrxCgpIWKpcj8U8DSa3gVB7RA/edit#
Contoh Tutorial Template: Decoder 7 Segmen Decoder 7 Segmen
Ringkasan:
Tutorial ini memberikan berbagai langkah untuk membuat decoder 7 segmen menggunakan CircuitVerse. Decoder adalah sirkuit kombinasi yang mengubah bilangan biner menjadi bilangan desimal yang sesuai. Komponen ini menggunakan empat bit input dan memiliki tujuh {i>output<i}.
Prosedur Desain
Untuk menghasilkan sirkuit tampilan 7 segmen di CircuitVerse, kita akan mengikuti langkah-langkah di bawah ini: Gunakan alat Analisis Kombinasi yang tersedia dalam simulator CircuitVerse untuk merumuskan tabel kebenaran. Dengan menggunakan tabel kebenaran ini, kita kemudian akan menghasilkan rangkaian di dalam simulator. Sirkuit ini akan mengarahkan {i>output<i} ke layar LED tujuh segmen. Hubungkan label masing-masing dari sirkuit kombinasi ke output masing-masing dari layar LED tujuh segmen untuk melihat sirkuit kita beraksi. Layar tujuh segmen adalah perangkat layar elektronik untuk menampilkan angka desimal dari 0 hingga 9.Lihat Analisis perilaku sirkuit menggunakan data tabel kebenaran. Tabel Truth Tabel 1 di bawah mencantumkan berbagai output untuk berbagai kombinasi input bagi decoder 7 segmen.
Daftar Elemen CircuitVerse
Tabel 2 mencantumkan berbagai komponen yang diperlukan untuk menerapkan rangkaian.
Formulate the Truth Table (Merumuskan Tabel Kebenaran)
Ikuti langkah-langkah di bawah ini untuk merumuskan tabel kebenaran dalam simulator CircuitVerse:
Selesaikan sirkuit
Lihat Gambar 10 untuk menghubungkan kabel input masing-masing untuk label rangkaian kombinasial yang sesuai ke output masing-masing dari tampilan tujuh segmen untuk menyelesaikan rangkaian. Video ini memperlihatkan sirkuit simulasi decoder 7 segmen yang dibuat dalam simulator CircuitVerse. Link Video: https://www.youtube.com/embed/tGTy4P-RxP0
Menganalisis Sirkuit
Ubah nilai input yang berbeda (S3, S2, S1, S0) dan validasi tabel kebenaran (lihat Tabel 1) untuk memverifikasi rangkaian decoder tujuh segmen yang diimplementasikan.
Komponen layar tujuh segmen memiliki 8 segmen LED di dalamnya dan salah satu ujung pinnya ditarik keluar dari modul seperti yang ditunjukkan pada Gambar 8. Untuk membuat LED segmen tertentu menyala, segmen yang relevan (diberi label sebagai a, b, c, d, e, f, g pada Gambar 10) harus dihidupkan untuk mewakili angka dari 0 hingga 9. Misalnya, untuk menampilkan angka 1, LED b dan c harus dinyalakan.
Jika LED gagal menampilkan angka desimal yang tepat, lihat Tabel 3 dan Gambar 10 dan pecahkan masalah koneksi kabel Anda. Tabel 3 mencantumkan konfigurasi pin tampilan 7 segmen.