En esta página, se incluyen los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- CircuitVerse
- Escritor técnico:
- Pragati
- Nombre del proyecto:
- Documentación y guías para el usuario
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Después de hacer un análisis detallado del público y la documentación para el usuario disponible actualmente, propongo las siguientes tareas de documentación:
1) Agrega instructivos en video para demostrar los flujos de trabajo populares y mejorar la experiencia de integración. Los videos describirán un solo concepto. Los videos te indicarán qué hacer mientras realizas esa acción en la pantalla.
Aquí puedes encontrar un vínculo a un video instructivo de ejemplo para usar la herramienta de análisis combinacional: https://www.youtube.com/watch?v=7FkeqBYcd1w Nota 1: Si bien este video ejemplifica el contenido existente, su objetivo es mostrar cómo se pueden usar las anotaciones para crear un estilo de video coherente. Nota 2: Cuando comience a trabajar para CircuitVerse, compraré una licencia para el software y el producto final no incluirá una marca de agua.
Temas sugeridos para los flujos de trabajo de instructivos en video: --Primeros pasos con CircuitVerse: Mira este instructivo en video para obtener un recorrido rápido de CircuitVerse --Uso de la Herramienta de análisis combinado: Mira este video instructivo para aprender a generar circuitos con los datos de la tabla de verdad. --Exportación de imágenes de alta resolución: Mira este instructivo en video para aprender a exportar imágenes de alta resolución de tus circuitos en varios formatos. --Uso de subcircuitos para el diseño estructurado: Mira este instructivo en video para aprender a crear subcircuitos que simplifiquen la estructura de circuitos complejos. --Uso de la herramienta convertidor hexadecimal, binario y decimal: Mira este instructivo en video para aprender a usar la herramienta convertidor hexadecimal, binario y decimal para el diseño y la implementación de circuitos. --Visualizar diagramas de temporización de circuitos para un circuito determinado: Mira este instructivo en video para aprender cómo los usuarios pueden visualizar diagramas de temporización de circuitos para un circuito determinado.
Algunos de los instructivos en video se pueden vincular entre páginas web y documentación para el usuario.
2) Crea una página de destino del instructivo para brindar una breve descripción general de la plataforma de CircuitVerse y proporcionar una vista gráfica de los diversos flujos de trabajo. Los usuarios accederán a una página de destino de instructivos en el sitio de GitHub de Circuitverse, que proporcionará un breve resumen de los diversos instructivos que se ofrecen para diferentes flujos de trabajo de contenido. Esto le permite al usuario ver y elegir diferentes instructivos según sus necesidades. A continuación, se muestra un ejemplo aproximado de la estructura de la página de destino del instructivo.
3) Crea instructivos paso a paso para enseñar a los usuarios cómo usar la herramienta para aprender y analizar el comportamiento de circuitos básicos y complejos. Enséñales a usar la herramienta jugando con ella. En relación con los proyectos destacados de CircuitVerse, propongo agregar al menos 5 instructivos para usuarios principiantes y de nivel intermedio para mejorar la experiencia de integración. Cada instructivo ilustra un flujo de trabajo completo y ofrece una introducción, seguida de un proceso de diseño, una lista de componentes, instrucciones paso a paso y ejercicios de práctica. En el caso de los flujos de trabajo complejos, los videos abarcarán una parte individual de un concepto general.
Visita este vínculo para ver un instructivo de muestra: Cómo crear un decodificador de siete segmentos: https://pragatijain.github.io/circuitverse/index.html
Algunos de los temas incluyen los siguientes: --Cómo crear una pantalla LED con desplazamiento --Cómo explorar cómo funciona un sumador de acarreo ondulante --Parte 1A: Cómo analizar un comparador de magnitud de 4 bits --Parte 1B: Cómo crear una calculadora hexadecimal --Cómo analizar una implementación de máquina de estados finitos (FSM)
4) Revisa la estructura de la navegación de la barra lateral para mejorar la coherencia, la legibilidad y la cohesión.
Herramientas del proyecto 1) Camtasia para instructivos de video. Usé una versión de prueba para crear el video de muestra. Cuando empiece a trabajar para CircuitVerse, compraré una licencia para el software y el producto final no incluirá una marca de agua. 2) Documentos de Google para escribir mis guías, que luego actualizaré en GitHub para alojarlas en el repositorio de CircuitVerse. 3) Lenguaje de marcado de Wiki y HTML para administrar mi contenido en GitHub
Cronograma Antes del 16 de agosto Realiza contribuciones a la organización en GitHub.
Vinculación con la comunidad (del 17 de agosto al 13 de septiembre) Configura un canal de comunicación y una hora (debido a la diferencia horaria). Definir mejor mis objetivos y establecer expectativas para ambas partes Obtén más información sobre la comunidad y el producto. Analiza y finaliza la estructura de documentación propuesta con los mentores y otros miembros de la organización.
Período de documentación Este proyecto seguirá los lineamientos de duración estándar (11 semanas en total, del 14/9/2020 al 30/11/2020). Pasaré alrededor de 20 horas a la semana completando los objetivos que se describen a continuación. Además de estos objetivos, participaré en reuniones de mentorización y comunicación durante este tiempo, según sea necesario. Trabajaré con los mentores para determinar el mejor momento para hacerlo. Nota: Este cronograma es flexible y reconoce que las necesidades de la organización pueden cambiar. Los largos plazos permiten flexibilidad y la capacidad de cambiar de enfoque, según sea necesario.
Semana 1: Revisa los eventos importantes identificados y defínelos mejor Forquea el repositorio de CircuitVerse y descárgalo en mi máquina Analiza con los mentores el estilo de los videos, así como desarrolla una plantilla de pantalla de apertura de video, cualquier música de relleno para el título y las pantallas finales, y la información adicional que se debe incluir. Revisa los temas de los tutoriales de video y obtén su aprobación. Identifica los temas de los tutoriales y obtén su aprobación. Revisa la estructura de navegación de la barra lateral y obtén su aprobación
Semana 2: Crear una plantilla del instructivo y obtener la aprobación del mentor Crear una página de destino del instructivo para alojar los instructivos
Semana 3, 4 y 5: Agrega videos instructivos para demostrar los diferentes flujos de trabajo del simulador.
Semana 6, 7, 8 y 9: Crea instructivos para diferentes circuitos simples y complejos
Semana 10: Reestructura la navegación de la barra lateral para lograr coherencia y mejorar la experiencia de integración del usuario
Semana 11: Revisar mi trabajo para detectar errores tipográficos y de error
Muestras de trabajo relevantes de CircuitVerse
*Visita este vínculo para ver un instructivo de ejemplo: Cómo crear un decodificador de siete segmentos. : https://pragatijain.github.io/circuitverse/index.html
*Este es un ejemplo de vínculo a un video instructivo para usar la Herramienta de análisis combinado: https://www.youtube.com/watch?v=7FkeqBYcd1w Nota 1: Si bien este video es un ejemplo de contenido existente, su objetivo es mostrar el estilo de cómo se pueden usar las anotaciones para crear un estilo de video coherente. Nota 2: Cuando comience a trabajar para GDevelop, compraré una licencia para el software y el producto final no incluirá una marca de agua.
*Página de destino del instructivo de CircuitVerse: https://docs.google.com/document/d/1sBKS2cq76zRHDGgA2Lbf7isSisRK_ELLSPsg-7atCAI/edit#
*Consulta la propuesta completa como documento de Google: https://docs.google.com/document/d/1vzYyDnX6mFXXByrcwVsrxCgpIWKpcj8U8DSa3gVB7RA/edit#
Plantilla de instructivo de muestra: decodificador de 7 segmentos Decodificador de 7 segmentos
Descripción general:
En este instructivo, se comparten diferentes pasos para crear un decodificador de 7 segmentos con CircuitVerse. Un decodificador es un circuito combinacional que convierte un número binario en el número decimal correspondiente. Recibe cuatro bits de entrada y tiene siete salidas.
Procedimiento de diseño
Para generar el circuito de pantalla de 7 segmentos en CircuitVerse, seguiremos los pasos que se indican a continuación: Usa la herramienta de análisis combinacional disponible en el simulador de CircuitVerse para formular la tabla de verdad. Con esta tabla de verdad, generaremos el circuito dentro del simulador. Este circuito dirigirá la salida a una pantalla LED de siete segmentos. Conecta las etiquetas correspondientes del circuito combinacional a las salidas de la pantalla LED de siete segmentos para ver nuestro circuito en acción. Una pantalla de siete segmentos es un dispositivo de visualización electrónico que muestra números decimales del 0 al 9.Consulta Analiza el comportamiento del circuito con los datos de la tabla de verdad. Tabla de verdad En la siguiente tabla 1, se enumeran diferentes salidas para diferentes combinaciones de entradas de un decodificador de 7 segmentos.
Lista de elementos de CircuitVerse
En la tabla 2, se enumeran los distintos componentes necesarios para implementar el circuito.
Formula la tabla de verdad
Sigue los pasos que se indican a continuación para formular la tabla de verdad en el simulador de CircuitVerse:
Completa el circuito
Consulta la Figura 10 para conectar los cables de entrada correspondientes de las etiquetas del circuito combinacional a las salidas correspondientes de la pantalla de siete segmentos y completar el circuito. En este video, se muestra un circuito simulado de decodificador de 7 segmentos creado en el simulador de CircuitVerse. Vínculo al video: https://www.youtube.com/embed/tGTy4P-RxP0
Analiza el circuito
Activa diferentes valores de entrada (S3, S2, S1 y S0) y valida la tabla de verdad (consulta la tabla 1) para verificar el circuito del decodificador de siete segmentos implementado.
Un componente de pantalla de siete segmentos tiene 8 segmentos LED en su interior y un extremo de sus pines extraídos del módulo, como se muestra en la Figura 8. Para que se ilumine un LED de un segmento en particular, los segmentos relevantes (etiquetados como a, b, c, d, e, f y g en la Figura 10) deben estar encendidos para representar los números del 0 al 9. Por ejemplo, para mostrar el número 1, los LED b y c deben estar encendidos.
Si el LED no muestra el número decimal correcto, consulta la Tabla 3 y la Figura 10, y soluciona los problemas de las conexiones de cableado. En la tabla 3, se muestra la configuración de los pines de la pantalla de 7 segmentos.