Ta strona została przetłumaczona przez Cloud Translation API.

Projekt CircuitVerse

Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.

Podsumowanie projektu

Organizacja open source:: CircuitVerse
Pisarz techniczny:: Pragati
Nazwa projektu:: Dokumentacja i przewodniki użytkownika
Długość projektu:: Standardowa długość (3 miesiące)

Opis projektu

Po przeprowadzeniu dogłębnej analizy odbiorców i obecnej dokumentacji użytkownika proponuję wykonanie poniższych zadań:

1) Dodaj samouczki wideo, aby zaprezentować popularne przepływy pracy i usprawnić proces wdrażania. Filmy będą zawierać 1 koncepcję. Podczas wykonywania tej czynności na ekranie filmy będą podpowiadać kierunki działania.

Przykładowy samouczek wideo, w którym dowiesz się, jak korzystać z narzędzia do analizy kombinacyjnej, znajdziesz tutaj: https://www.youtube.com/watch?v=7FkeqBYcd1w Uwaga 1: chociaż ten film przedstawia istniejące już treści, ma pokazać, w jaki sposób można wykorzystać adnotacje do stworzenia spójnego stylu filmu. Uwaga 2: gdy zacznę pracować dla CircuitVerse, kupię licencję na oprogramowanie, a ostateczny produkt nie będzie zawierał znaku wodnego.

Proponowane tematy pracy w samouczku wideo: – Wprowadzenie do CircuitVerse: obejrzyj ten samouczek wideo, aby poznać krótką prezentację CircuitVerse. – Korzystanie z narzędzia do analizy kombinacyjnej: obejrzyj ten samouczek wideo, aby dowiedzieć się, jak generować obwody za pomocą danych z tabeli prawd. – Eksportowanie obrazów w wysokiej rozdzielczości: obejrzyj ten samouczek wideo, aby dowiedzieć się, jak eksportować obwody o wysokiej rozdzielczości w wielu formatach. --Korzystanie z podobwodów w projekcie ustrukturyzowanym: obejrzyj ten samouczek wideo, aby dowiedzieć się, jak tworzyć układy podrzędne upraszczające strukturę złożonych obwodów. – Korzystanie z narzędzia do konwertowania obwodów hex-Bin-Dec. – Wizualizacja schematów czasowych obwodów dla danego obwodu: obejrzyj ten samouczek wideo, aby dowiedzieć się, jak użytkownicy mogą zwizualizować schematy czasowe obwodów w danym obwodzie.

Niektóre samouczki wideo można połączyć ze stronami internetowymi i dokumentacją użytkownika.

2) Utwórz stronę docelową samouczka, która zawiera krótki opis platformy CircuitVerse oraz graficzny widok różnych przepływów pracy. Na stronie docelowej z samouczkami w witrynie Circuitverse GitHub znajdują się krótkie opisy różnych samouczków dostępnych na potrzeby różnych przepływów pracy z treściami. Dzięki temu użytkownik może przeglądać i wybierać różne samouczki odpowiadające jego potrzebom. Poniżej przedstawiamy przykładową strukturę strony strony docelowej samouczka.

3) Opracować szczegółowe samouczki, z których użytkownicy nauczą się korzystać z tego narzędzia, aby nauczyć się i analizować zachowanie podstawowych i złożonych obwodów. Naucz się korzystać z narzędzia, bawiąc się tym narzędziem. Nawiązując do polecanych projektów CircuitVerse, proponuję dodać co najmniej 5 samouczków dla początkujących i średnio zaawansowanych użytkowników, aby usprawnić wprowadzenie. Każdy samouczek ma na celu ilustrację pełnego przepływu pracy. Każdy samouczek obejmuje wprowadzenie do samouczka, potem proces projektowania, listę komponentów, szczegółowe instrukcje i ćwiczenia praktyczne. W przypadku skomplikowanych procesów filmy będą opisywać poszczególne aspekty ogólnego zagadnienia.

Kliknij ten link, aby zobaczyć przykładowy samouczek: „Budowanie siedmiosegmentowego dekodera”: https://pragatijain.github.io/processuitverse/index.html

Wybrane tematy: – budowanie ruchomego wyświetlacza LED; – omówienie, jak działa sumer z falą, – Część 1A: przeanalizuj komparator 4-bitowy. – Część 1B: budowanie kalkulatora szesnastkowego; – analiza implementacji maszyny skończonej (FSM).

4) Zmienić strukturę paska nawigacyjnego w celu zwiększenia spójności, czytelności i spójności.

Narzędzia projektu 1) Camtasia do samouczków wideo. Nagrałem(-am) przykładowy film w wersji próbnej. Gdy zacznę pracować dla CircuitVerse, kupię licencję na oprogramowanie, a ostateczny produkt nie będzie zawierał znaku wodnego. 2) Dokumenty Google do napisania moich przewodników, które później zaktualizuję w GitHubie i hostuję w repozytorium CircuitVerse. 3) Znaczniki Wiki i kod HTML do zarządzania treścią w GitHubie.

Oś czasu Przed 16 sierpnia Opublikuj treści dla organizacji na GitHubie.

Nawiązywanie więzi ze społecznością (17 sierpnia–13 września) Określ kanał komunikacji i termin komunikacji (ze względu na różnicę czasu). Przedstawiciel sprecyzował moje cele i określił oczekiwania po obu stronach. Dowiedz się więcej o społeczności i usłudze. Omów z mentorami i innymi członkami organizacji proponowaną strukturę dokumentacji, aby ją sfinalizować.

Okres dokumentacji Projekt musi spełniać standardowe wytyczne dotyczące długości trwania projektu (łącznie 11 tygodni, od 14 września do 30 listopada 2020 r.). Będę poświęcać około 20 godzin tygodniowo na realizację celów wymienionych poniżej. Oprócz tego będę w tym czasie brać udział w spotkaniach z mentorami i w razie potrzeby brać udział w komunikacji. Wspólnie z mentorami określimy, kiedy najlepiej się to odbywa. Uwaga: ten harmonogram jest elastyczny i uwzględnia fakt, że potrzeby organizacji mogą się zmieniać. Długie przedziały czasowe dają elastyczność i możliwość przełączania się w razie potrzeby.

Tydzień 1: przeglądanie zidentyfikowanych kamieni milowych i ulepszenie ich Repozytorium Fork CircuitVerse i pobranie go na mój komputer Omów z mentorami styl filmów, a także opracuj szablon ekranu otwierającego film, dodaj muzykę do tytułu i ekranów końcowych oraz podaj dodatkowe informacje, które należy uwzględnić. Zapoznaj się z tematami samouczków wideo i poproś o ich zatwierdzenie. Zidentyfikuj tematy poruszane w samouczkach i poproś o ich zatwierdzenie. Sprawdź strukturę paska nawigacyjnego i zatwierdź ją

Tydzień 2: Stworzenie szablonu samouczka i uzyskanie go zatwierdzenia przez mentora Tworzenie strony docelowej samouczka na potrzeby hostowania samouczków

Tydzień 3, 4, 5: dodaj samouczki wideo, aby zademonstrować różne procesy związane z symulatorami

Tydzień 6, 7, 8 i 9. Twórz samouczki dotyczące różnych prostych i złożonych obwodów

Tydzień 10: zmiana struktury paska bocznego nawigacyjnego w celu zwiększenia spójności i usprawnienia procesu wprowadzania użytkowników

Tydzień 11. Sprawdź moje dane pod kątem literówek i błędów.

Odpowiednie przykłady prac w obwodzie obwodu

*Kliknij ten link, aby zobaczyć przykładowy samouczek: Budowanie siedmiosegmentowego dekodera. https://pragatijain.github.io/processuitverse/index.html

*Przykładowy samouczek wideo do korzystania z narzędzia do analizy kombinacyjnej znajdziesz tutaj: https://www.youtube.com/watch?v=7FkeqBYcd1w Uwaga 1: ten film pokazuje przykłady obecnych treści, ale ma pokazać, w jaki sposób można wykorzystać adnotacje do stworzenia spójnego stylu filmu. Uwaga 2: w momencie rozpoczęcia pracy w GDevelop kupuję licencję na oprogramowanie, a ostateczna wersja produktu nie będzie zawierać znaku wodnego.

*Strona docelowa samouczka na temat korzystania z narzędzia CircuitVerse https://docs.google.com/document/d/1sBKS2cq76zRHDGgA2Lbf7isSisRK_ELLSPsg-7atCAI/edit#

*Zobacz pełną propozycję jako dokument Google: https://docs.google.com/document/d/1vzYyDnX6mFXXByrcwVsrxCgpIWKpcj8U8DSa3gVB7RA/edit#

Przykładowy szablon samouczka: 7-segmentowy dekoder 7-segmentowy dekoder

Omówienie

W tym samouczku pokazujemy, jak utworzyć 7-segmentowy dekoder za pomocą CircuitVerse. Dekoder to obwód łączący, który konwertuje liczbę binarną na odpowiednią liczbę dziesiętną. Przyjmuje 4 bity wejściowe i ma 7 wyjść wyjściowych.

Procedura projektowania

Aby wygenerować obwód wyświetlania 7-segmentowego w CircuitVerse, wykonaj następujące czynności: Do określenia tabeli prawdy użyj narzędzia analizy kombinacyjnej dostępnego w symulatorze CircuitVerse. Na podstawie tej tabeli prawdy utworzymy następnie obwód w symulatorze. Ten obwód będzie kierować wyjście do 7-segmentowego wyświetlacza LED. Podłącz odpowiednie etykiety obwodu wielofunkcyjnego do odpowiednich wyjść siedmiosegmentowego wyświetlacza LED, by zobaczyć, jak działa nasz obwód. Wyświetlacz siedmiosegmentowy to elektroniczny wyświetlacz do wyświetlania liczb dziesiętnych od 0 do 9.Analiza działania obwodu za pomocą danych z tabeli prawdy. Tabela prawdy W tabeli 1 znajdziesz różne dane wyjściowe dla różnych kombinacji danych wejściowych dla dekodera 7-segmentowego.

Lista elementów CircuitVerse

W tabeli 2 wymieniono różne komponenty wymagane do zaimplementowania obwodu.

Sformułuj tabelę prawdy

Aby w symulatorze CircuitVerse utworzyć tabelę prawdziwości, wykonaj te czynności:

Dokończ obwód

Rysunek 10 pokazuje, jak podłączyć odpowiednie przewody wejściowe dla odpowiednich etykiet obwodu zespolonego do odpowiednich wyjść siedmiosegmentowego wyświetlacza w celu ukończenia obwodu. Ten film przedstawia symulowany obwód siedmiosegmentowy dekodera zbudowany w symulatorze CircuitVerse. Link do filmu: https://www.youtube.com/embed/tGTy4P-RxP0

Przeanalizuj obwód

Przełącz różne wartości wejściowe (S3, S2, S1, S0) i zweryfikuj tabelę prawdy (patrz Tabela 1), aby sprawdzić zaimplementowany obwód dekodera 7 segmentów.

Komponent wyświetlacza z siedmioma segmentami składa się z 8 segmentów LED i pozostałych końcówek wyjętych z modułu, tak jak to widać na Rysunku 8. Aby świecąca dioda LED konkretnego segmentu, odpowiednie segmenty (oznaczone jako a, b, c, d, e, f, g na Rysunku 10) muszą być włączone, aby reprezentowały liczby od 0 do 9. Na przykład do wyświetlania liczby 1 muszą być włączone diody LED b i c.

Jeśli dioda LED nie wskaże prawidłowej liczby dziesiętnej, zapoznaj się z tabelami 3 i 10 oraz rozwiąż problemy z połączeniami okablowania. W tabeli 3 znajduje się konfiguracja PIN-u w wyświetlaczu z 7 segmentami.