Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- CircuitVerse
- Penulis teknis:
- Pragati
- Nama project:
- Dokumentasi dan Panduan Pengguna
- Durasi project:
- Durasi standar (3 bulan)
Project description
Setelah melakukan analisis mendalam terhadap audiens dan dokumentasi pengguna yang tersedia saat ini, saya mengusulkan tugas dokumentasi di bawah ini:
1) Tambahkan tutorial video untuk menunjukkan alur kerja populer dan meningkatkan pengalaman orientasi. Video akan menguraikan satu konsep. Video akan memberikan petunjuk saat melakukan tindakan tersebut di layar.
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 contoh konten yang ada, video ini dimaksudkan untuk menunjukkan gaya cara anotasi dapat digunakan untuk membuat gaya video yang konsisten. Catatan 2: Saat mulai bekerja untuk CircuitVerse, saya akan membeli lisensi untuk software tersebut dan produk akhir tidak akan menyertakan watermark.
Topik yang disarankan untuk alur kerja tutorial video: --Memulai CircuitVerse: Tonton tutorial video ini untuk tur singkat CircuitVerse --Menggunakan Alat Analisis Kombinasi: Tonton tutorial video ini untuk mempelajari cara membuat sirkuit menggunakan data tabel kebenaran. --Mengekspor Gambar Resolusi Tinggi: Tonton tutorial video ini untuk mempelajari cara mengekspor gambar resolusi tinggi dari sirkuit Anda dalam beberapa format --Menggunakan Subsirkuit untuk Desain Terstruktur: Tonton tutorial video ini untuk mempelajari cara membuat subsirkuit guna menyederhanakan struktur sirkuit yang kompleks --Menggunakan Alat Konverter Hex-Bin-Dec: Tonton tutorial video ini untuk mempelajari cara menggunakan alat Konverter Hex-Bin-Dec untuk desain dan implementasi sirkuit. --Memvisualisasikan diagram pengaturan waktu sirkuit untuk sirkuit tertentu: Tonton tutorial video ini untuk mempelajari cara pengguna dapat memvisualisasikan diagram waktu sirkuit untuk sirkuit tertentu.
Beberapa tutorial video dapat saling ditautkan di seluruh halaman web dan dokumentasi pengguna.
2) Membuat halaman landing tutorial untuk memberikan ringkasan singkat tentang platform CircuitVerse serta memberikan tampilan grafis dari berbagai alur kerja. Pengguna akan mengakses halaman landing tutorial di situs Circuitverse GitHub yang akan memberikan penjelasan singkat tentang berbagai tutorial yang ditawarkan untuk berbagai alur kerja konten. Hal ini memberi pengguna kemampuan untuk melihat dan memilih berbagai tutorial sesuai kebutuhan mereka. Berikut adalah contoh kasar struktur halaman halaman landing tutorial.
3) Buat tutorial langkah demi langkah untuk mengedukasi pengguna tentang cara menggunakan alat ini untuk mempelajari dan menganalisis perilaku sirkuit dasar dan kompleks–ajarkan alat ini dengan memainkannya. Sehubungan dengan project unggulan CircuitVerse, saya mengusulkan untuk menambahkan minimal 5 tutorial bagi pengguna tingkat pemula dan menengah untuk meningkatkan pengalaman orientasi. Untuk mengilustrasikan alur kerja yang lengkap, setiap tutorial akan memberikan pengantar tutorial, diikuti dengan proses desain, daftar komponen, petunjuk langkah demi langkah, dan latihan praktik. Untuk alur kerja yang kompleks, video akan membahas bagian individual dari keseluruhan konsep.
Buka link ini untuk melihat contoh tutorial: Membuat Seven Segment Decoder: https://pragatijain.github.io/circuitverse/index.html
Beberapa topiknya antara lain: --Membuat layar LED yang berputar --Pelajari cara kerja ripple bring adder --Bagian 1A: Menganalisis pembanding magnitudo 4-bit --Bagian 1B: Membuat kalkulator heksadesimal --Menganalisis implementasi finite state machine (FSM)
4) Merevisi struktur navigasi sidebar untuk meningkatkan konsistensi, keterbacaan, dan kepaduan.
Alat Project 1) Camtasia untuk tutorial video. Saya telah menggunakan versi uji coba untuk membuat video contoh. Ketika mulai bekerja untuk CircuitVerse, saya akan membeli lisensi perangkat lunak tersebut dan produk akhirnya tidak akan menyertakan watermark. 2) Dokumen Google untuk menulis panduan saya yang nantinya akan saya perbarui di GitHub untuk dihosting di repositori CircuitVerse. 3) Markup Wiki dan HTML untuk mengelola konten saya di GitHub.
Linimasa Sebelum 16 Agustus Buat kontribusi ke organisasi di GitHub.
Pengikatan komunitas (17 Agustus - 13 September) Siapkan saluran komunikasi dan waktu (karena perbedaan waktu). Mempertajam sasaran dan menetapkan ekspektasi di kedua belah pihak. Pelajari lebih lanjut komunitas dan produk. Membahas dan menyelesaikan struktur dokumentasi yang diusulkan dengan mentor dan anggota lain dari organisasi.
Periode dokumentasi Project ini akan mengikuti panduan project dengan durasi standar (total 11 minggu, dari 14/9/2020 hingga 30/11/2020). Saya akan menghabiskan sekitar 20 jam seminggu untuk menyelesaikan sasaran yang diuraikan di bawah. Selain tujuan ini, saya akan berpartisipasi dalam pertemuan dan komunikasi mentor selama waktu ini, sesuai kebutuhan. Saya akan bekerja sama dengan mentor untuk menentukan waktu terbaik untuk ini. Catatan: Linimasa ini bersifat fleksibel dan mengakui fakta bahwa kebutuhan organisasi dapat berubah. Jangka waktu yang besar memungkinkan fleksibilitas dan kemampuan untuk beralih fokus, sesuai kebutuhan.
Minggu 1: Tinjau pencapaian yang diidentifikasi dan tingkatkan kualitasnya Fork repositori CircuitVerse dan download ke komputer saya Diskusikan dengan mentor gaya untuk video, serta kembangkan template layar pembuka video, musik pengisi untuk layar judul dan penutup, serta informasi tambahan yang harus disertakan. Meninjau topik tutorial video dan mendapatkan persetujuan Mengidentifikasi topik tutorial dan mendapatkan persetujuan. Meninjau struktur navigasi sidebar dan mendapatkan persetujuan
Minggu ke-2: Membuat template tutorial dan mendapatkan persetujuan dari mentor Membuat halaman landing tutorial untuk menghosting tutorial
Minggu 3, 4, 5: Menambahkan video tutorial untuk mendemonstrasikan alur kerja simulator yang berbeda
Minggu 6, 7, 8, 9: Membuat tutorial untuk berbagai sirkuit sederhana dan kompleks
Minggu 10: Menyusun ulang navigasi sidebar untuk konsistensi guna meningkatkan pengalaman orientasi pengguna
Minggu ke-11: Memeriksa tata bahasa pekerjaan saya untuk menemukan kesalahan ketik dan kesalahan.
Contoh Pekerjaan CircuitVerse yang Relevan
*Buka link ini untuk melihat contoh tutorial: Membuat Seven Segment Decoder. : 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 contoh konten yang ada, video ini dimaksudkan untuk menunjukkan gaya cara anotasi dapat digunakan untuk membuat gaya video yang konsisten. Catatan 2: Saat mulai bekerja untuk GDevelop, saya akan membeli lisensi untuk software tersebut dan produk akhir tidak akan menyertakan watermark.
*Halaman Landing Tutorial CircuitVerse 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 Template Tutorial: Decoder 7 Segmen Decoder 7 Segmen
Ringkasan:
Tutorial ini membagikan berbagai langkah untuk membuat decoder 7 segmen menggunakan CircuitVerse. Dekoder adalah sirkuit kombinasional yang mengonversi bilangan biner menjadi bilangan desimal yang sesuai. Lapisan ini menggunakan empat bit input dan memiliki tujuh output.
Prosedur Desain
Untuk membuat sirkuit tampilan 7 segmen di CircuitVerse, kita akan mengikuti langkah-langkah di bawah: Gunakan alat Analisis Kombinasi yang tersedia dalam simulator CircuitVerse untuk merumuskan tabel kebenaran. Dengan menggunakan tabel kebenaran ini, kita akan membuat sirkuit dalam simulator. Sirkuit ini akan mendorong output ke layar LED tujuh segmen. Hubungkan label masing-masing sirkuit kombinasional ke output masing-masing layar LED tujuh segmen untuk melihat cara kerja sirkuit kita. Layar tujuh segmen adalah perangkat layar elektronik untuk menampilkan angka desimal dari 0 hingga 9.Lihat Menganalisis perilaku sirkuit menggunakan data tabel kebenaran. Tabel Kebenaran Tabel 1 di bawah mencantumkan output yang berbeda untuk berbagai kombinasi input untuk decoder 7 segmen.
Daftar Elemen CircuitVerse
Tabel 2 mencantumkan berbagai komponen yang diperlukan untuk mengimplementasikan sirkuit.
Merumuskan Tabel Kebenaran
Ikuti langkah-langkah di bawah ini untuk merumuskan tabel kebenaran dalam simulator CircuitVerse:
Menyelesaikan sirkuit
Lihat Gambar 10 untuk menghubungkan kabel input masing-masing untuk label sirkuit kombinasional yang sesuai ke output masing-masing dari tampilan tujuh segmen untuk menyelesaikan sirkuit. Video ini menunjukkan sirkuit simulasi decoder 7 segmen yang dibuat dalam simulator CircuitVerse. Link Video: https://www.youtube.com/embed/tGTy4P-RxP0
Analisis Sirkuit
Alihkan nilai input yang berbeda (S3, S2, S1, S0) dan validasi tabel kebenaran (lihat Tabel 1) untuk memverifikasi sirkuit decoder tujuh segmen yang diterapkan.
Komponen layar tujuh segmen memiliki 8 segmen LED di dalamnya dan salah satu ujung pin ditarik keluar dari modul seperti yang ditunjukkan pada Gambar 8. Agar LED segmen tertentu menyala, segmen yang relevan (berlabel a, b, c, d, e, f, g pada Gambar 10) harus diaktifkan untuk merepresentasikan angka dari 0 hingga 9. Misalnya, untuk menampilkan angka 1, LED b dan c harus diaktifkan.
Jika LED gagal menampilkan angka desimal yang benar, lihat Tabel 3 dan Gambar 10, lalu pecahkan masalah koneksi jaringan Anda. Tabel 3 mencantumkan konfigurasi pin tampilan 7 segmen.