Esta página foi traduzida pela API Cloud Translation.

Projeto CircuitVerse

Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.

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 (3 meses)

Project description

Depois de fazer uma análise detalhada do público-alvo e da documentação do usuário atual disponível, sugiro as tarefas 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 apresentarão um único conceito. Os vídeos vão indicar uma direção enquanto executam essa ação na tela.

Um exemplo de link de tutorial em vídeo para usar a Ferramenta de análise de combinações pode ser encontrado aqui: https://www.youtube.com/watch?v=7FkeqBYcd1w Observação 1: este vídeo é um exemplo de conteúdo existente, mas o objetivo dele é 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 CircuitVerse, comprarei uma licença para o software, e o produto final não incluirá uma marca-d'água.

Tópicos sugeridos para os fluxos de trabalho do tutorial em vídeo: --Introdução ao CircuitVerse: assista a este tutorial em vídeo para fazer um tour rápido pelo CircuitVerse. --Como usar a Ferramenta de análise combinada: assista a este tutorial em vídeo para aprender a gerar circuitos usando dados da tabela de verdade. --Como exportar imagens de alta resolução: assista a este tutorial em vídeo para aprender como exportar imagens de alta resolução de seus circuitos em vários formatos --Como usar subcircuitos para design estruturado: assista a este tutorial em vídeo para saber como criar subcircuitos para simplificar a estrutura de circuitos complexos --Como usar a ferramenta de conversão Hex-Bin-Dec: assista ao tutorial em vídeo para aprender a usar a ferramenta de design e conversão de circuito hexadecimal. --Visualizar diagramas de tempo de circuito para um determinado circuito: assista a este tutorial em vídeo para saber como os usuários podem visualizar os diagramas de tempo de circuito para um circuito específico.

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

2) Crie uma página de destino de tutorial para fornecer uma breve visão geral da plataforma do CircuitVerse, além de uma visualização gráfica dos vários fluxos de trabalho. Os usuários vão acessar uma página de destino no site do Circuitverse do GitHub com uma breve descrição dos tutoriais oferecidos para diferentes fluxos de trabalho de conteúdo. Isso permite que o usuário visualize e escolha tutoriais diferentes de acordo com as necessidades. Veja abaixo um exemplo aproximado da estrutura de página de destino do tutorial.

3) Criar tutoriais passo a passo para educar os usuários sobre como eles podem usar a ferramenta para aprender e analisar o comportamento de circuitos básicos e complexos. Ensine a ferramenta brincando com a ferramenta. Com relação aos projetos em destaque do CircuitVerse, proponho a inclusão de 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 fornecerá uma introdução ao tutorial, seguido por um processo de design, lista de componentes, instruções passo a passo e exercícios práticos. Para fluxos de trabalho complexos, os vídeos abordarão uma parte individual de um conceito geral.

Acesse este link para ver um tutorial de exemplo: Criar um decodificador de sete segmentos: https://pragatijain.github.io/circuitverse/index.html (em inglês)

Alguns dos tópicos incluem: --Criar uma tela LED contínua --Explorar como funciona um somador de ondulação --Parte 1A: analisar um comparador de magnitude de 4 bits --Parte 1B: como criar calculadora hexadecimal -- Analisar a implementação de uma máquina de estado finito (FSM, na sigla em inglês)

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

Ferramentas do projeto 1) Camtasia para 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, comprarei uma licença para o software, e o produto final não incluirá uma marca-d'água. 2) Documentos Google para escrever meus guias, que vou atualizar posteriormente no GitHub para hospedar no repositório do CircuitVerse. 3) Marcação 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.

Vínculo comunitário (17 de agosto a 13 de setembro) Configure um canal de comunicação e um horário (devido à diferença de horário). Refinar minhas metas e definir expectativas em ambos os lados. Saiba mais sobre a comunidade e o produto. Discutir e finalizar a estrutura de documentação proposta com os mentores e outros membros da organização.

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

Semana 1: Analise e refine os marcos identificados O repositório do Fork CircuitVerse e faça o download para minha máquina Discuta com os mentores o estilo para vídeos, além de desenvolver um modelo de tela de abertura do vídeo, qualquer música para o título e as telas finais e informações adicionais que precisam ser incluídas. Analise os tópicos dos tutoriais em vídeo e faça com que eles sejam aprovados Identifique os tópicos do tutorial para que sejam aprovados. Revisar a estrutura de navegação da barra lateral e torná-la aprovada

Semana 2: Criar modelo de tutorial e receber aprovação do mentor Criar página de destino para hospedar os tutoriais

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

Semana 6, 7, 8, 9: crie tutoriais para diferentes circuitos simples e complexos

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

Semana 11: revisar meu trabalho para corrigir erros de digitação e erros.

Amostras relevantes de trabalho do CircuitVerse

*Visite este link para visualizar um tutorial de exemplo: Criar um decodificador de sete segmentos. : https://pragatijain.github.io/circuitverse/index.html (link em inglês)

*Veja aqui um exemplo do link de tutorial em vídeo sobre como usar a Ferramenta de análise de combinação: https://www.youtube.com/watch?v=7FkeqBYcd1w Observação 1: este vídeo é um exemplo do conteúdo atual, mas o objetivo dele é mostrar o estilo de uso das anotações para criar um estilo de vídeo consistente. Observação 2: quando começar a trabalhar para o GDevelop, vou comprar uma licença para o software, e o produto final não vai incluir uma marca-d'água.

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

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

Modelo de tutorial de exemplo: decodificador de sete segmentos decodificador de sete segmentos

Visão geral:

Este tutorial compartilha diferentes etapas para criar um decodificador de sete segmentos usando o CircuitVerse. Um decodificador é um circuito combinado 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 projeto

Para gerar o circuito de exibição de sete segmentos no CircuitVerse, seguiremos as etapas abaixo: Use a ferramenta de análise de combinação disponível no simulador do CircuitVerse para formular a tabela de verdade. Usando essa tabela de verdade, vamos gerar o circuito dentro do simulador. Esse circuito vai gerar saída para um visor de LED de sete segmentos. Conecte os respectivos rótulos do circuito combinado às respectivas saídas do visor de LED de sete segmentos para ver nosso circuito em ação. Um visor de sete segmentos é um dispositivo de exibição eletrônico para exibir 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 diferentes combinações de entrada para 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:

Complete o circuito

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

Analise o circuito

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

Um componente de tela de sete segmentos tem oito segmentos de LED dentro dele e uma extremidade dos pinos é puxada para fora do módulo, como mostrado na Figura 8. Para fazer um LED de um segmento específico brilhar, os segmentos relevantes (identificados como a, b, c, d, e, f, g na Figura 10) devem estar ligados 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 as Tabelas 3 e 10 para resolver problemas nas conexões da fiação. A Tabela 3 lista a configuração do pino da tela de 7 segmentos.