Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source
- CircuitVerse
- Pisarz techniczny:
- Pragati
- Nazwa projektu:
- Dokumentacja i przewodniki dla użytkowników
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Po dokładnej analizie odbiorców i dostępnej obecnie dokumentacji użytkowników proponuję wykonać te zadania:
1) Dodaj samouczki wideo, aby przedstawić popularne przepływy pracy i ułatwić wprowadzenie. Filmy będą przedstawiać pojedynczą koncepcję. Filmy będą zawierać instrukcje dotyczące wykonywania danej czynności na ekranie.
Przykładowy link do samouczka wideo na temat korzystania z narzędzia do analizy kombinacji znajdziesz tutaj: https://www.youtube.com/watch?v=7FkeqBYcd1w Uwaga 1: w tym filmie przedstawiamy przykłady istniejących treści, ale ma on pokazać, jak można wykorzystać adnotacje do utworzenia spójnego stylu filmu. Uwaga 2. Gdy zacznę pracować dla CircuitVerse, kupię licencję na oprogramowanie, a produkt końcowy nie będzie zawierać znaku wodnego.
Sugerowane tematy do tutoriali wideo: – Pierwsze kroki z CircuitVerse: obejrzyj ten film, aby poznać CircuitVerse; – Korzystanie z narzędzia do analizy kombinacyjnej: obejrzyj ten film, aby dowiedzieć się, jak generować obwody za pomocą danych z tabeli prawdy. --Eksportowanie obrazów w wysokiej rozdzielczości: obejrzyj samouczek wideo, aby dowiedzieć się, jak eksportować obrazy obwodów w różnych formatach. --Korzystanie z konwertera Hex-Bin-Dec: obejrzyj samouczek wideo, aby dowiedzieć się, jak używać konwertera Hex-Bin-Dec do projektowania i wdrażania obwodów. --Wizualizacja diagramów czasowych obwodów dla danego obwodu: obejrzyj samouczek wideo, aby dowiedzieć się, jak użytkownicy mogą wizualizować diagramy czasowe obwodów dla danego obwodu.
Niektóre samouczki wideo mogą być połączone z innymi stronami internetowymi i dokumentacją użytkownika.
2) Utwórz stronę docelową z samouczkiem, aby krótko przedstawić platformę CircuitVerse i zaprezentować graficznie różne przepływy pracy. Użytkownicy będą mieć dostęp do strony docelowej z samouczkiem na stronie Circuitverse GitHub, która zawiera krótkie omówienie różnych samouczków oferowanych w ramach różnych procesów związanych z treściami. Dzięki temu użytkownik będzie mógł obejrzeć i wybrać różne samouczki dopasowane do jego potrzeb. Poniżej znajduje się przybliżony przykład struktury strony docelowej z samouczkiem.
3) Utwórz samouczki krok po kroku, aby pokazać użytkownikom, jak mogą korzystać z narzędzia do nauki i analizowania zachowania prostych i złożonych obwodów. W związku z polecanymi projektami CircuitVerse proponuję dodanie co najmniej 5 samouczków dla początkujących i zaawansowanych użytkowników, aby ułatwić im zapoznanie się z aplikacją. Każdy samouczek zawiera wprowadzenie, proces projektowania, listę komponentów, szczegółowe instrukcje i ćwiczenia praktyczne. W przypadku złożonych procesów filmy będą dotyczyć poszczególnych części ogólnego zagadnienia.
Aby obejrzeć przykładowy samouczek, kliknij ten link: https://pragatijain.github.io/circuitverse/index.html
Porusz ten temat: – Zbudowanie ruchomego wyświetlacza LED – Zapoznanie się z działaniem czujnika efektu fali – Część 1A: Analiza 4-bitowego porównania wielkości –– Część 1B: Tworzenie kalkulatora szesnastkowego
4) Zmień strukturę paska bocznego, aby poprawić spójność, czytelność i spójność.
Narzędzia w projekcie 1) Camtasia na potrzeby samouczków wideo. Do nagrania przykładowego filmu użyłem wersji próbnej. Gdy zacznę pracować dla CircuitVerse, kupię licencję na oprogramowanie, a produkt końcowy nie będzie zawierał znaku wodnego. 2) Dokumenty Google do pisania moich przewodników, które później będę aktualizować w GitHubie, aby przechowywać w repozytorium CircuitVerse. 3) znaczniki Wiki i HTML do zarządzania treściami w GitHub.
Harmonogram Przed 16 sierpnia Dodaj swój wkład w organizację w GitHub.
Tworzenie więzi społecznych (17 sierpnia – 13 września) Wybierz kanał komunikacji i termin rozmowy (z powodu różnicy czasu). Doprecyzuj cele i określ oczekiwania po obu stronach. Dowiedz się więcej o społeczności i usłudze. Omów i ostatecznie zaakceptuj proponowaną strukturę dokumentacji z mentorami i innymi członkami organizacji.
Okres dokumentacji Ten projekt będzie realizowany zgodnie ze standardowymi wytycznymi dotyczącymi długości projektu (łącznie 11 tygodni, od 14.09.2020 r. do 30.11.2020 r.). Będę poświęcać około 20 godzin tygodniowo na realizację celów opisanych poniżej. Oprócz realizacji tych celów będę w razie potrzeby brać udział w spotkaniach z mentorami i komunikacji. Wspólnie z mentorami ustalimy najlepszy termin. Uwaga: ten harmonogram jest elastyczny i uwzględnia fakt, że potrzeby organizacji mogą się zmieniać. Długie okresy umożliwiają elastyczność i możliwość zmiany priorytetów w razie potrzeby.
Tydzień 1: sprawdź zidentyfikowane etapy i je udoskonalaj; forkuj repozytorium CircuitVerse i pobierz je na swój komputer; porozmawiaj z mentorami o stylu filmów, a także przygotuj szablon otwierającego ekranu filmu, muzykę wypełniającą na potrzeby ekranów tytułowych i końcowych oraz dodatkowe informacje, które powinny się znaleźć w filmach. Przejrzyj tematy samouczków wideo i uzyskaj ich zatwierdzenie. Zidentyfikuj tematy samouczków i uzyskaj ich zatwierdzenie. Zapoznaj się ze strukturą nawigacji na pasku bocznym i poproś o jej zatwierdzenie
Tydzień 2. Utwórz szablon samouczka i uzyskaj jego zatwierdzenie przez mentora. Utwórz stronę docelową samouczka, na której będą się one znajdować.
Tydzień 3, 4 i 5: dodaj samouczki wideo, aby zademonstrować różne przepływy pracy w symulatorze
Tydzień 6, 7, 8 i 9: tworzenie samouczków dotyczących różnych prostych i skomplikowanych obwodów
Tydzień 10.: Zmień strukturę paska nawigacyjnego, aby zapewnić spójność i ułatwić użytkownikom zapoznanie się z usługą
Tydzień 11. Sprawdzanie tekstu pod kątem literówek i błędów.
Odpowiednie przykładowe projekty w CircuitVerse
*Kliknij ten link, aby wyświetlić przykładowy samouczek: tworzenie dekodera 7-segmentowego. : https://pragatijain.github.io/circuitverse/index.html
*Link do przykładowego samouczka na temat korzystania z narzędzia do analizy kombinacyjnej: https://www.youtube.com/watch?v=7FkeqBYcd1w Uwaga 1: ten film pokazuje przykładowe istniejące treści, ale ma też na celu zaprezentować, jak można używać adnotacji do tworzenia spójnego stylu filmu. Uwaga 2. Gdy zacznę pracę dla GDevelop, kupuję licencję na oprogramowanie, a ostateczna wersja produktu nie będzie zawierać znaku wodnego.
*Strona docelowa samouczka CircuitVerse https://docs.google.com/document/d/1sBKS2cq76zRHDGgA2Lbf7isSisRK_ELLSPsg-7atCAI/edit#
*Pełną propozycję możesz wyświetlić w dokumentach Google: https://docs.google.com/document/d/1vzYyDnX6mFXXByrcwVsrxCgpIWKpcj8U8DSa3gVB7RA/edit#
Przykładowy szablon samouczka: dekoder 7 segmentów
Omówienie
W tym samouczku opisujemy różne kroki tworzenia dekodera 7-segmentowego za pomocą CircuitVerse. Dekoder to układ kombinacyjny, który przekształca liczbę binarną w odpowiednią liczbę dziesiętną. Zajmuje 4 bity danych wejściowych i ma 7 wyjść.
Procedura projektowania
Aby wygenerować obwód wyświetlacza 7-segmentowego w CircuitVerse, wykonaj te czynności: Użyj narzędzia do analizy kombinacyjnej dostępnego w symulatorze CircuitVerse, aby sformułować tablicę prawdy. Na podstawie tej tabeli danych wygenerujemy następnie obwód w symulatorze. To obwody będzie sterować wyświetlaczem LED z 7 segmentami. Aby zobaczyć działanie obwodu, połącz odpowiednie etykiety obwodu kombinacyjnego z odpowiednimi wyjściami wyświetlacza siedmiosegmentowego LED. Wyświetlacz siedmiosegmentowy to elektroniczne urządzenie wyświetlające cyfry dziesiętne od 0 do 9.Zapoznaj się z zachowaniem obwodu za pomocą danych z tabeli prawdy. Tabela prawdy W tabeli 1. poniżej podano różne wyjścia dla różnych kombinacji danych wejściowych dekodera 7-segmentowego.
Lista elementów CircuitVerse
Tabela 2 zawiera różne komponenty wymagane do wdrożenia obwodu.
Tworzenie tabeli danych podstawowych
Aby sformułować tablicę prawdy w symulatorze CircuitVerse:
Zakończ obwód
Aby dokończyć obwód, podłącz odpowiednie przewody wejściowe odpowiadających etykiet obwodu kombinacyjnego do odpowiednich wyjść wyświetlacza siedmiosegmentowego, korzystając z Rysunku 10. Ten film pokazuje symulowany obwód dekodera 7-segmentowego utworzony w symulatorze CircuitVerse. Link do filmu: https://www.youtube.com/embed/tGTy4P-RxP0
Analiza obwodu
Przełącz różne wartości wejściowe (S3, S2, S1, S0) i zweryfikuj tabelę danych (patrz tabela 1), aby sprawdzić zaimplementowany obwód dekodera 7-segmentowego.
Element wyświetlacza siedmiusegmentowego ma 8 segmentów LED i jeden koniec pinów wyciągnięty z modułu, jak pokazano na rysunku 8. Aby dioda LED konkretnego segmentu świeciła, odpowiednie segmenty (oznaczone jako a, b, c, d, e, f, g na rys. 10) muszą być zasilane, tak by reprezentowały liczby z zakresu od 0 do 9. Aby na przykład wyświetlać liczbę 1, muszą być włączone diody LED b i c.
Jeśli dioda LED nie wyświetla prawidłowej liczby dziesiętnej, zapoznaj się z tabelą 3 i rysunkiem 10 oraz rozwiąż problemy z połączeniami przewodów. Tabela 3 zawiera konfigurację pinezki wyświetlania 7 segmentów.