Projeto CircuitVerse

Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.

Resumo do projeto

Organização de código aberto:
CircuitVerse
Redator técnico:
Pragati
Nome do projeto:
Documentação e guias do usuário
Duração do projeto:
Duração padrão (três meses)

Project description

Depois de fazer uma análise detalhada do público-alvo e da documentação de usuário disponível, proponho as tarefas de documentação abaixo:

1) Adicione tutoriais em vídeo para demonstrar os fluxos de trabalho mais usados e melhorar a experiência de integração. Os vídeos vão descrever um único conceito. Os vídeos vão dar uma direção ao realizar essa ação na tela.

Confira aqui um exemplo do link de tutorial em vídeo para usar a Ferramenta de análise combinada: https://www.youtube.com/watch?v=7FkeqBYcd1w Observação 1: embora este vídeo exemplifique um conteúdo que já existe, ele serve para mostrar como as anotações podem ser usadas para criar um estilo de vídeo consistente. Observação 2: quando eu começar a trabalhar para a CircuitVerse, vou comprar uma licença para o software, e o produto final não vai incluir uma marca d'água.

Temas sugeridos para os fluxos de trabalho do tutorial em vídeo: --Como começar a usar o CircuitVerse: assista este tutorial em vídeo para fazer um tour rápido pelo CircuitVerse --Como usar a ferramenta de análise combinatória: assista este tutorial em vídeo para saber como gerar circuitos usando dados de tabelas de verdade. --Como exportar imagens em alta resolução: assista a este tutorial em vídeo para saber como exportar imagens de alta resolução dos seus circuitos em vários formatos --Como usar subcircuitos para design estruturado: assista a este tutorial em vídeo para aprender a criar subcircuitos para simplificar a estrutura de circuitos complexos --Como usar a ferramenta de conversão de hex-Bin-Dec: assista a este tutorial em vídeo para aprender a usar a Ferramenta Hex-Bin-Decor Design. --Visualizar diagramas de temporização de circuitos para um determinado circuito: assista este tutorial em vídeo para saber como os usuários podem visualizar diagramas de temporização de circuitos para um determinado circuito.

Alguns dos tutoriais em vídeo podem ser interligados entre páginas da Web e documentações do usuário.

2) Crie uma página inicial tutorial para fornecer uma breve visão geral da plataforma CircuitVerse, bem como fornecer uma visão gráfica dos vários fluxos de trabalho. Os usuários vão acessar uma página de destino de tutorial no site do GitHub do Circuitverse, que vai fornecer um breve resumo dos vários tutoriais oferecidos para diferentes fluxos de conteúdo. Isso permite que o usuário visualize e escolha diferentes tutoriais de acordo com as necessidades dele. Abaixo está um exemplo aproximado da estrutura da página de destino do tutorial.

3) Crie tutoriais passo a passo para ensinar os usuários a usar a ferramenta para aprender e analisar o comportamento de circuitos básicos e complexos. Ensine a ferramenta brincando com ela. Em relação aos projetos em destaque do CircuitVerse, proponho adicionar pelo menos cinco tutoriais para usuários iniciantes e intermediários para melhorar a experiência de integração. Ilustrando um fluxo de trabalho completo, cada tutorial vai apresentar uma introdução, seguida de um processo de design, uma lista de componentes, instruções detalhadas e exercícios práticos. Para fluxos de trabalho complexos, os vídeos abrangem uma parte individual de um conceito geral.

Acesse este link para conferir um exemplo de tutorial: Criar um decodificador de sete segmentos: https://pragatijain.github.io/circuitverse/index.html

Alguns dos tópicos incluem: --Criar um display LED contínuo --Conhecer o funcionamento de um somador de ripple carry --Parte 1A: analisar um comparador de magnitude de 4 bits --Parte 1B: criar uma calculadora hexadecimal --Analisar uma implementação de máquina de estado finito (FSM)

4) Revise a estrutura da navegação da barra lateral para melhorar a consistência, a legibilidade e a coesão.

Ferramentas de projeto 1) Camtasia para ver tutoriais em vídeo. Usei uma versão de teste para fazer o vídeo de amostra. Quando eu começar a trabalhar para a CircuitVerse, vou comprar uma licença para o software, e o produto final não vai incluir uma marca d'água. 2) Documentos do Google para escrever meus guias, que serão atualizados no GitHub para hospedagem no repositório do CircuitVerse. 3) Marcação de wiki e HTML para gerenciar meu conteúdo no GitHub.

Cronograma Antes de 16 de agosto Faça contribuições para a organização no GitHub.

Interação com a comunidade (17 de agosto a 13 de setembro) Defina um canal e horário de comunicação (devido à diferença de horário). Refinar minhas metas e definir as expectativas de ambos os lados. Saiba mais sobre a comunidade e o produto. Discuta e finalize a estrutura de documentação proposta com os mentores e outros membros da organização.

Período de documentação Este projeto vai seguir as diretrizes padrão de duração do projeto (11 semanas no total, de 14/09/2020 a 30/11/2020). Vou dedicar cerca de 20 horas por semana para cumprir as metas descritas abaixo. Além dessas metas, vou participar de reuniões de mentoria e comunicação durante esse período, conforme necessário. Vou trabalhar com os mentores para determinar o melhor momento para isso. Observação: esse cronograma é flexível e reconhece o fato de que as necessidades organizacionais podem mudar. Os períodos longos permitem a flexibilidade e a capacidade de mudar o foco, conforme necessário.

Semana 1: Revisar e refinar os marcos identificados Fork do repositório do CircuitVerse e faça o download dele na minha máquina Discutir com os mentores o estilo dos vídeos, além de desenvolver um modelo de tela de abertura de vídeo, qualquer música de preenchimento para o título e telas finais e outras informações que devem ser incluídas. Revise os tópicos do tutorial em vídeo e aprove-o. Identifique os tópicos do tutorial e aprove-o. Analisar a estrutura de navegação da barra lateral e solicitar a aprovação

Semana 2: criar um modelo de tutorial e aprová-lo pelo mentor Criar uma página de destino para hospedar os tutoriais

Semanas 3, 4 e 5: adicionar tutoriais em vídeo para demonstrar diferentes fluxos de trabalho do simulador

Semanas 6, 7, 8 e 9: criar tutoriais para circuitos simples e complexos diferentes

Semana 10: Reestruturar a navegação da barra lateral para melhorar a experiência de integração do usuário

Semana 11: revisar meu trabalho em busca de erros de digitação e outros erros.

Amostras de trabalho relevantes do CircuitVerse

*Acesse este link para ver um tutorial de exemplo: Criar um decodificador com sete segmentos. : https://pragatijain.github.io/circuitverse/index.html

*Confira aqui um link de tutorial em vídeo de exemplo sobre como usar a ferramenta de análise combinatória: https://www.youtube.com/watch?v=7FkeqBYcd1w Observação 1: embora esse vídeo exemplifique o conteúdo existente, ele tem como objetivo mostrar o estilo de como as anotações podem ser usadas para criar um estilo de vídeo consistente. Observação 2: quando eu começar a trabalhar para a GDevelop, vou comprar uma licença para o software, e o produto final não vai incluir uma marca d'água.

*Página de destino do tutorial do CircuitVerse https://docs.google.com/document/d/1sBKS2cq76zRHDGgA2Lbf7isSisRK_ELLSPsg-7atCAI/edit#

*Confira a proposta completa como um documento do Google: https://docs.google.com/document/d/1vzYyDnX6mFXXByrcwVsrxCgpIWKpcj8U8DSa3gVB7RA/edit#

Modelo de tutorial de exemplo: decodificador de 7 segmentos Decodificador de 7 segmentos

Visão geral:

Este tutorial mostra as diferentes etapas para criar um decodificador de 7 segmentos usando o CircuitVerse. Um decodificador é um circuito combinacional que converte um número binário no número decimal correspondente. Ele recebe quatro bits de entrada e tem sete saídas.

Procedimento de design

Para gerar o circuito de exibição de 7 segmentos no CircuitVerse, vamos seguir as etapas abaixo: Use a ferramenta de análise combinatória disponível no simulador do CircuitVerse para formular a tabela de verdade. Usando essa tabela de verdade, vamos gerar o circuito no simulador. Esse circuito vai direcionar a saída para um display de LED de sete segmentos. Conecte os respectivos rótulos do circuito combinacional às respectivas saídas do display de LED de sete segmentos para conferir o circuito em ação. Um display de sete segmentos é um dispositivo de exibição eletrônica para mostrar números decimais de 0 a 9.Consulte Analise o comportamento do circuito usando os dados da tabela de verdade. A Tabela de verdade A Tabela 1 abaixo lista diferentes saídas para combinações distintas de entrada em um decodificador de sete segmentos.

Lista de elementos do CircuitVerse

A Tabela 2 lista os diferentes componentes necessários para implementar o circuito.

Formular a tabela de verdade

Siga as etapas abaixo para formular a tabela de verdade no simulador do CircuitVerse:

Concluir o circuito

Consulte a Figura 10 para conectar os respectivos fios de entrada dos rótulos correspondentes do circuito combinacional às respectivas saídas do display de sete segmentos para completar o circuito. Este vídeo demonstra um circuito simulado de decodificador de 7 segmentos criado no simulador do CircuitVerse. Link do vídeo: https://www.youtube.com/embed/tGTy4P-RxP0

Analisar o circuito

Alterne diferentes valores de entrada (S3, S2, S1, S0) e valide a tabela de verdade (consulte a Tabela 1) para verificar o circuito de decodificador de sete segmentos implementado.

Um componente de tela de sete segmentos tem 8 segmentos de LED dentro dele e tem uma extremidade dos pinos extraída do módulo, como mostrado na Figura 8. Para acender um LED de um segmento específico, os segmentos relevantes (marcados como a, b, c, d, e, f, g na Figura 10) precisam ser ativados para representar os números de 0 a 9. Por exemplo, para exibir o número 1, os LEDs b e c precisam estar ligados.

Se o LED não mostrar o número decimal correto, consulte a Tabela 3 e a Figura 10 e resolva os problemas de conexão dos fios. A Tabela 3 lista a configuração do pino do display de sete segmentos.