Bu sayfada, Google Dokümanlar Sezonu için kabul edilen bir teknik yazım projesinin ayrıntıları yer almaktadır.
Proje özeti
- Açık kaynak kuruluşu:
- CircuitVerse
- Teknik yazar:
- Pragati
- Proje adı:
- Kullanıcı Dokümanları ve Kılavuzları
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
Kitleyi ve mevcut kullanıcı dokümanlarını ayrıntılı bir şekilde analiz ettikten sonra aşağıdaki doküman görevlerini öneriyorum:
1) Popüler iş akışlarını göstermek ve ilk katılım deneyimini iyileştirmek için eğitim videoları ekleyin. Videolarda tek bir kavram özetlenir. Videolarda, ekranda ilgili işlem yapılırken yönergeler gösterilir.
Kombinasyonel Analiz Aracı'nın kullanımıyla ilgili örnek bir eğitim videosu bağlantısını burada bulabilirsiniz: https://www. youtube.com/watch?v=7FkeqBYcd1w 1.Not: Bu videoda mevcut içerik örnekleri sunulsa da videoda, tutarlı bir video stili oluşturmak için ek açıklamaların nasıl kullanılabileceği gösterilmektedir. 2. Not: CircuitVerse için çalışmaya başladığımda yazılım için bir lisans satın alacağım ve nihai üründe filigran olmayacak.
Video eğitim iş akışları için önerilen konular: --CircuitVerse'e Başlama: CircuitVerse'i hızlıca gezmek için bu eğitim videosunu izleyin --Kombinasyonel Analiz Aracı'nı Kullanma: Mantık tablosu verilerini kullanarak devreleri nasıl oluşturacağınızı öğrenmek için bu eğitim videosunu izleyin. --Yüksek Çözünürlüklü Görüntüleri Dışa Aktarma: Devrelerinizin yüksek çözünürlüklü resimlerini birden fazla biçimde nasıl dışa aktaracağınızı öğrenmek için bu eğitim videosunu izleyin. --Yapılandırılmış Tasarım İçin Alt Devreleri Kullanma: Karmaşık devrelerin yapısını basitleştirmek için nasıl alt devre oluşturacağınızı öğrenmek için bu eğitim videosunu izleyin. --Hex-Bin-Dec Dönüştürücü Aracı Kullanma: Devre tasarımı ve uygulama için Hex-Bin-Dec Dönüştürücü aracını nasıl kullanacağınızı öğrenmek için bu eğitim videosunu izleyin. --Belirli bir devre için devre zamanlama diyagramlarını görselleştirme: Kullanıcıların belirli bir devre için devre zamanlaması diyagramlarını nasıl görselleştirebileceklerini öğrenmek için bu eğitim videosunu izleyin.
Video eğitimlerinden bazıları, web sayfaları ve kullanıcı dokümanları arasında bağlantı oluşturabilir.
2) CircuitVerse platformuna kısa bir genel bakış sunmanın yanı sıra çeşitli iş akışlarının grafiksel bir görünümünü sağlamak için bir eğitim açılış sayfası oluşturun. Kullanıcılar, Circuitverse GitHub sitesinde bir eğitim açılış sayfasına erişir. Bu sayfada, farklı içerik iş akışları için sunulan çeşitli eğitimlerin kısa bir özeti yer alır. Bu, kullanıcıya ihtiyaçlarına göre farklı eğiticileri görüntüleme ve seçme olanağı sunar. Eğitim açılış sayfasının sayfa yapısının kaba bir örneğini aşağıda bulabilirsiniz.
3) Kullanıcılara temel ve karmaşık devrelerin davranışını öğrenmek ve analiz etmek için aracı nasıl kullanabilecekleri hakkında bilgi vermek üzere adım adım açıklamalı eğitici içerikler oluşturun. Araçla oynayarak aracı öğretin. CircuitVerse'te öne çıkarılan projelere baktığımızda, ilk katılım deneyimini iyileştirmek için başlangıç ve orta düzey kullanıcılar için en az 5 eğitici içerik eklemeyi öneriyorum. İş akışının tamamını gösteren her eğiticide, eğitim için bir giriş yapılacak, ardından tasarım süreci, bileşen listesi, adım adım talimatlar ve alıştırma alıştırmaları yapılacak. Karmaşık iş akışlarında videolar, genel bir kavramın ayrı bir bölümünü kapsar.
Örnek bir eğitim görmek için şu bağlantıyı ziyaret edin: Yedi Segmentli Kod Çözücü Oluşturma: https://pragatijain.github.io/circuitverse/index.html
Bazı konular şunlardır: --Kayan LED ekran oluşturma --Dalgalı carry toplayıcının nasıl çalıştığını keşfetme --1. Bölüm A: 4 bitlik büyüklük karşılaştırıcıyı analiz etme --1. Bölüm B: On altılık hesap makinesi oluşturma --Sonlu durum makinesi (FSM) uygulamasını analiz etme
4) Daha tutarlı, okunaklı ve uyumlu bir deneyim için kenar çubuğu gezinme yapısında düzeltme yapın.
Proje Araçları 1) Videolu eğitimler için Camtasia. Örnek videoyu oluşturmak için deneme sürümünü kullandım. CircuitVerse için çalışmaya başladığımda yazılım için bir lisans satın alacağım ve nihai üründe filigran olmayacak. 2) Kılavuzlarımı yazmak için kullanılan Google dokümanları. Bu dosyaları, daha sonra GitHub'da CircuitVerse deposunda barındıracağım. 3) GitHub'daki içeriğimi yönetmek için Wiki işaretleme ve HTML.
Zaman çizelgesi 16 Ağustos'tan önce GitHub'da kuruluşa katkıda bulunun.
Topluluk bağ kurma (17 Ağustos - 13 Eylül) Bir iletişim kanalı oluşturun ve zaman farkı nedeniyle). Hedeflerimi hassaslaştırın ve her iki taraf için de beklentileri belirleyin. Topluluk ve ürün hakkında daha fazla bilgi edinin. Önerilen doküman yapısı hakkında mentorlarla ve kuruluşun diğer üyeleriyle görüşüp bu yapıyı kesinleştirin.
Belgelendirme dönemi Bu projede standart uzunluktaki proje yönergeleri (14.9.2020 - 30.11.2020 tarihleri arasında toplam 11 hafta) geçerli olacaktır. Aşağıda belirtilen hedefleri tamamlamak için haftada yaklaşık 20 saat harcayacağım. Bu hedeflere ek olarak, bu süre zarfında gerektiğinde mentor toplantılarına ve iletişime katılacağım. Bunun için en uygun zamanı belirlemek üzere mentorlarla birlikte çalışacağım. Not: Bu zaman çizelgesi esnektir ve kuruluş ihtiyaçlarının değişebileceğini dikkate alır. Geniş zaman aralıkları esnekliğe ve gerektiğinde odak değişikliğine olanak tanır.
1. Hafta: Belirlenen aşamaları inceleyin ve hassaslaştırın CircuitVerse deposunu çatallayın ve bilgisayarıma indirin Videoların tarzını mentorlarla tartışın, ayrıca bir video açılış ekranı şablonu, başlık ve bitiş ekranları için doldurma müzikleri ve dahil edilmesi gereken ek bilgileri geliştirin. Eğitim videolarının konularını inceleyin ve onaylatın. Eğitim konularını belirleyin ve onaylatın. Kenar çubuğu gezinme yapısını inceleyin ve onaylatın.
2. Hafta: Eğitim şablonu oluşturun ve bu şablonu mentorunuzdan onaylayın Eğitimleri barındırmak için eğitim açılış sayfası oluşturun
3., 4. ve 5. hafta: Farklı simülatör iş akışlarını gösteren eğitim videoları ekleyin
6., 7., 8. ve 9. hafta: Farklı basit ve karmaşık devreler için eğitici içerikler oluşturun
10. hafta: Kullanıcı ilk katılım deneyimini iyileştirmek için kenar çubuğu gezinme çubuğunu tutarlılık sağlayacak şekilde yeniden yapılandırın
11. Hafta: Çalışmamı yazım hataları ve hatalar açısından gözden geçirin.
İlgili CircuitVerse Çalışma Örnekleri
*Örnek bir eğitim videosunu görüntülemek için şu bağlantıyı ziyaret edin: Yedi Segmentli Kod Çözücü Oluşturma. : https://pragatijain.github.io/circuitverse/index.html
*Kombinasyonel Analiz Aracı'nın kullanımıyla ilgili örnek bir eğitim videosu bağlantısını burada bulabilirsiniz: https://www. youtube.com/watch?v=7FkeqBYcd1w 1.Not: Bu videoda mevcut içerikler örnek olarak gösterilse de videonun amacı, tutarlı bir video stili oluşturmak için ek açıklamaların nasıl kullanılabileceğini göstermektir. 2. Not: GDevelop için çalışmaya başladığımda yazılım için bir lisans satın alacağım ve nihai üründe filigran olmayacak.
*CircuitVerse Eğitimi Açılış Sayfası https://docs.google.com/document/d/1sBKS2cq76zRHDGgA2Lbf7isSisRK_ELLSPsg-7atCAI/edit#
*Teklifin tamamını Google Dokümanlar olarak görüntüleyin: https://docs.google.com/document/d/1vzYyDnX6mFXXByrcwVsrxCgpIWKpcj8U8DSa3gVB7RA/edit#
Örnek Eğitim Şablonu: 7 Segment Kod Çözücü 7 Segment Kod Çözücü
Genel Bakış:
Bu eğitimde, CircuitVerse'ı kullanarak 7 segmentli bir kod çözücü oluşturmayla ilgili farklı adımlar paylaşılmaktadır. Kod çözücü, bir ikili sayıyı karşılık gelen ondalık sayıya dönüştüren bir kombinasyonel devredir. Dört bit giriş alır ve yedi çıkışı vardır.
Tasarım Prosedürü
CircuitVerse'te 7 segmentli görüntü devresini oluşturmak için aşağıdaki adımları izleyeceğiz: Doğruluk tablosunu formüle etmek için CircuitVerse simülatöründe bulunan Kombinasyonel Analiz aracını kullanın. Ardından bu doğruluk tablosunu kullanarak simülatörde devreyi oluşturacağız. Bu devre, çıkışı yedi segmentli bir LED ekrana yönlendirir. Devremizin çalışırken nasıl göründüğünü görmek için kombinasyonel devrenin ilgili etiketlerini yedi segmentli LED ekranın ilgili çıkışlarına bağlayın. Yedi segmentli ekran, 0 ile 9 arasındaki ondalık sayıları görüntülemek için kullanılan elektronik bir ekran cihazıdır.Doğruluk tablosu verilerini kullanarak devrenin davranışını analiz edin. Gerçek Tablosu: Aşağıdaki Tablo 1'de, 7 segmentli bir kod çözücü için farklı giriş kombinasyonlarının farklı çıkışları listelenmiştir.
CircuitVerse Öğe Listesi
Tablo 2'de, devrenin uygulanması için gereken farklı bileşenler listelenmiştir.
Doğruluk tablosunu formüle etme
CircuitVerse simülatöründe doğruluk tablosunu oluşturmak için aşağıdaki adımları uygulayın:
Devreyi tamamlayın
Devreyi tamamlamak için kombinasyonel devrenin ilgili etiketlerine ait giriş kablolarını yedi segmentli ekranın ilgili çıkışlarına bağlamak üzere Şekil 10'a bakın. Bu videoda, CircuitVerse simülatöründe yerleşik olarak bulunan 7 segmentli kod çözücü simüle edilmiş devre gösterilmektedir. Video Bağlantısı: https://www.youtube.com/embed/tGTy4P-RxP0
Devreyi analiz etme
Uygulanan yedi segmentli kod çözücü devresini doğrulamak için farklı giriş değerlerini (S3, S2, S1, S0) değiştirin ve mantık tablosunu doğrulayın (Tablo 1'e bakın).
Yedi segmentli ekran bileşeninde 8 LED segment bulunur ve bu segmentlerin pinlerinin bir ucu, Şekil 8'de gösterildiği gibi modülden dışarı çekilir. Belirli bir segmentin LED'inin yanması için ilgili segmentler (Şekil 10'da a, b, c, d, e, f, g olarak etiketlenmiştir) 0 ile 9 arasındaki sayıları temsil edecek şekilde açılmalıdır. Örneğin, 1 sayısının gösterilmesi için b ve c LED'leri açık olmalıdır.
LED doğru ondalık sayıyı göstermiyorsa Tablo 3 ve Şekil 10'a bakın ve kablo bağlantılarınızla ilgili sorunları giderin. Tablo 3'te, 7 segment görüntülü PIN yapılandırması listelenmektedir.