Esta página contiene 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:
- Guías y documentación del usuario
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Después de hacer un análisis profundo del público y la documentación del usuario disponible actual, propongo las siguientes tareas de documentación:
1) Agrega instructivos en video para mostrar los flujos de trabajo populares y mejorar la experiencia de integración. Los videos describirán un solo concepto. Los videos te indicarán cómo realizar la acción en la pantalla.
Aquí puede encontrar un ejemplo de vínculo de 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 en 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: --Cómo comenzar a usar CircuitVerse: Mira este video instructivo para hacer un recorrido rápido por CircuitVerse --Cómo usar la herramienta de análisis combinado: Mira este video instructivo para aprender a generar circuitos con datos de tablas de verdad. --Cómo exportar imágenes de alta resolución: Mira este tutorial en video para aprender a exportar imágenes de alta resolución de tus circuitos en varios formatos --Cómo usar subcircuitos para el diseño estructurado: Mira este video instructivo para aprender a crear subcircuitos para simplificar la estructura de circuitos complejos --Cómo usar la herramienta de conversión de hexadecimales-dic: Mira este instructivo en video para aprender a usar la herramienta de conversión de circuitos hexadecimales y de diciembre. --Visualización de diagramas de tiempo de un circuito dado: Mira este tutorial en video para aprender cómo los usuarios pueden visualizar los diagramas de latencia de un circuito determinado.
Algunos de los instructivos en video pueden vincularse entre páginas web y documentación del usuario.
2) Crea una página de destino del instructivo para brindar una descripción general breve de la plataforma CircuitVerse y proporcionar una vista gráfica de los diversos flujos de trabajo. Los usuarios accederán a una página de destino con instructivos en el sitio de GitHub de Circuitverse, en la que se proporcionará un resumen breve de los distintos instructivos disponibles para los diferentes flujos de trabajo de contenido. Esto le permite al usuario ver y elegir diferentes instructivos según sus necesidades. A continuación, se incluye un ejemplo aproximado de la estructura de la página de destino del instructivo.
3) Crea instructivos paso a paso para educar a los usuarios sobre cómo pueden usar la herramienta para aprender y analizar el comportamiento de circuitos básicos y complejos. Enséñale a la herramienta jugando con ella. En cuanto a los proyectos destacados de CircuitVerse, propongo agregar al menos 5 instructivos para usuarios de nivel principiante e intermedio para mejorar la experiencia de integración. Con el fin de ilustrar un flujo de trabajo completo, cada tutorial proporcionará una introducción al tutorial, seguido de un proceso de diseño, una lista de componentes, instrucciones paso a paso y ejercicios de práctica. En el caso de flujos de trabajo complejos, los videos cubrirá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 son los siguientes: --Crear una pantalla LED rodante --Explorar cómo funciona una suma de transporte de ondas -Parte 1A: Analizar un comparador de magnitud de 4 bits -Parte 1B: Crear una calculadora hexadecimal -- Analizar la implementación de una máquina de estado finito (FSM)
4) Revisa la estructura de la navegación de la barra lateral para mejorar la coherencia, legibilidad y cohesión.
Herramientas del proyecto 1) Camtasia para instructivos en video Utilicé una versión de prueba para realizar el video de muestra. Cuando comience a trabajar en CircuitVerse, compraré una licencia para el software, y el producto final no incluirá una marca de agua. 2) Documentos de Google para escribir guías que actualizaré más adelante en GitHub a fin de alojarlos 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 y horario de comunicación (debido a las diferencias horarias). Definir mejor mis objetivos y establecer expectativas para ambos lados. Obtén más información sobre la comunidad y el producto. Debatir y finalizar 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 del proyecto (11 semanas en total, desde el 14/9/2020 hasta el 30/11/2020). Dedicaré alrededor de 20 horas a la semana a completar los objetivos que se describen a continuación. Además de estos objetivos, participaré en reuniones con mentores y en comunicaciones durante este período, según sea necesario. Trabajaré con los mentores para determinar el mejor momento para esto. Nota: Este cronograma es flexible y reconoce el hecho de que las necesidades de la organización pueden cambiar. Los amplios plazos permiten la flexibilidad y la posibilidad de cambiar el enfoque, según sea necesario.
Semana 1: Revisa los hitos identificados y perfecciona el repositorio de Fork CircuitVerse y descárgalo en mi equipo. Analiza con los mentores el estilo de los videos y desarrolla una plantilla de pantalla de apertura para el video, 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 instructivos y obtén su aprobación. Revisa la estructura de navegación de la barra lateral y obtén su aprobación
Semana 2: Crea una plantilla de instructivo y obtén la aprobación del mentor Crea una página de destino para los instructivos
Semanas 3, 4 y 5: Agregar instructivos de video para mostrar diferentes flujos de trabajo del simulador
Semanas 6, 7, 8 y 9: Crea instructivos para diferentes circuitos simples y complejos.
Semana 10: Reestructura la barra lateral para mantener la coherencia y mejorar la experiencia de integración del usuario
Semana 11: Corregir mi trabajo para detectar errores tipográficos y de error.
Muestras relevantes de trabajos de CircuitVerse
*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
*Aquí puede encontrar un ejemplo de vínculo de 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 en 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#
*Ver 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 los 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. Toma cuatro bits de entrada y tiene siete salidas.
Procedimiento de diseño
Para generar el circuito de visualización 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 conducirá la salida a una pantalla LED de siete segmentos. Conecta las etiquetas correspondientes del circuito combinacional a las respectivas 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ónica para mostrar números decimales del 0 al 9.Consulta Analiza el comportamiento del circuito usando los datos de la tabla de verdad. Tabla de verdad En la tabla 1, se muestran diferentes resultados para distintas combinaciones de entrada para un decodificador de 7 segmentos.
Lista de elementos de CircuitVerse
En la tabla 2, se enumeran los diferentes componentes necesarios para implementar el circuito.
Formula la tabla de la verdad
Sigue los pasos que se indican a continuación para crear la tabla de verdad dentro del simulador de CircuitVerse:
Completa el circuito
Consulta la Figura 10 para conectar los cables de entrada correspondientes a las etiquetas correspondientes del circuito combinacional a las respectivas salidas de la pantalla de siete segmentos para completar el circuito. En este video, se muestra un circuito simulado con decodificador de 7 segmentos creado dentro del simulador de CircuitVerse. Vínculo del video: https://www.youtube.com/embed/tGTy4P-RxP0
Analiza el circuito
Activa o desactiva diferentes valores de entrada (S3, S2, S1, S0) y valida la tabla de verdad (consulta la Tabla 1) para verificar el circuito implementado del decodificador de siete segmentos.
Un componente de pantalla de siete segmentos tiene 8 segmentos LED en su interior y un extremo de sus clavijas extraído del módulo, como se muestra en la Figura 8. Para que se ilumine la luz LED de un segmento específico, los segmentos relevantes (etiquetados como a, b, c, d, e, f y g en la Figura 10) deben encenderse para representar los números del 0 al 9. Por ejemplo, para mostrar el número 1, las luces LED b y c deben estar encendidas.
Si el LED no muestra el número decimal correcto, consulta la Tabla 3 y la Figura 10 para solucionar los problemas de las conexiones del cableado. En la tabla 3, se muestra la configuración de los pines de la pantalla de 7 segmentos.