本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- CircuitVerse
- 技术文档工程师：
- Pragati
- 项目名称：
- 用户文档和指南
- 项目时长：
- 标准时长（3 个月）
Project description
在对受众群体和当前可用的用户文档进行深入分析后，我提议完成以下文档任务：
1) 添加视频教程来演示常用工作流程并改进新手入门体验。视频将概述一个概念。在屏幕上执行该操作时，视频会给出指示。
有关使用组合分析工具的视频教程示例链接，请访问此处：https://www.youtube.com/watch?v=7FkeqBYcd1w 备注 1：虽然本视频是对现有内容的示例，但旨在展示如何使用注释功能来打造一致的视频风格。 注 2：当我开始为 CircuitVerse 工作时，我会购买软件的许可，最终的产品不会带有水印。
视频教程工作流的建议主题： --CircuitVerse 使用入门：观看此视频教程，快速了解 CircuitVerse --使用组合分析工具：观看此视频教程，了解如何使用真实表数据生成电路。 --导出高分辨率图像：观看此视频教程，了解如何以多种格式导出高分辨率的电路图像 --使用子电路实现结构化设计：观看此视频教程，了解如何创建子电路以简化复杂电路的结构 --使用十六进制回馈 (Hex-Bin-Dec) 转换器工具：观看此视频教程，了解如何使用十六进制转换电路工具。 --显示给定电路的电路时序图： 观看此视频教程，了解用户如何可视化给定电路的电路时序图。
某些视频教程可以在各个网页和用户文档中相互链接。
2) 创建教程着陆页，简要概述 CircuitVerse 平台，并提供各种工作流的图形视图。用户将访问 Circuitverse GitHub 网站上的教程着陆页，该页面将简要介绍为不同内容工作流提供的各种教程。这让用户能够根据自己的需求查看和选择不同的教程。以下是教程着陆页网页结构的粗略示例。
3) 创建分步教程，指导用户如何使用该工具学习和分析基本和复杂电路的行为 - 通过使用该工具来教授该工具。针对 CircuitVerse 精选项目，我建议至少添加 5 个面向初级和中级用户的教程，以改善新手入门体验。每个教程都会说明一个完整的工作流程，都会先介绍教程，然后是设计流程、组件列表、分步说明和练习练习。对于复杂的工作流程，视频将仅涵盖整体概念中的单个部分。
访问此链接查看示例教程：构建七段解码器：https://pragatijain.github.io/electricverse/index.html
部分主题包括： --构建滚动 LED 显示屏 --探索涟漪带动加法器的工作原理 --第 1A 部分：分析 4 位量级比较器 --第 1B 部分：构建十六进制计算器 --分析有限状态机 (FSM) 实现
4) 修改边栏导航的结构，以提高一致性、可读性和连贯性。
项目工具 1) 使用 Camtasia 观看视频教程。我使用了试用版来制作示例视频。在开始为 CircuitVerse 工作时，我会购买软件的许可，最终的产品不会带有水印。 2) 用于编写指南的 Google 文档，我稍后将在 GitHub 中更新这些指南，以将其托管在 CircuitVerse 代码库中。 3) 使用 Wiki 标记和 HTML 管理我在 GitHub 中的内容。
时间表 8 月 16 日之前 在 GitHub 上为组织做贡献。
社区凝聚（8 月 17 日至 9 月 13 日） （由于时差问题）设立沟通渠道并安排时间。 调整我的目标，并为双方设定预期。 详细了解社区和产品。 与导师及其他组织成员讨论并最终敲定建议的文档结构。
文档制作周期 此项目将遵循标准时长项目准则（从 2020 年 9 月 14 日至 2020 年 11 月 30 日，总共 11 周）。我每周会花大约 20 个小时来完成下面列出的目标。除了这些目标之外，我还会根据需要参加导师会议和沟通交流。我会和导师一起确定完成这项任务的最佳时机。 注意：这个时间表很灵活，并认可了组织需求可能会发生变化的事实。较大的时间范围可让您根据需要灵活地切换焦点。
第 1 周： 检查确定的里程碑并对其进行优化 Fork CircuitVerse 代码库并将其下载到我的计算机上 与导师讨论视频的风格，并制作视频开场屏幕模板、标题和片尾画面中的任何填充音乐，以及应包含的其他信息。 审核视频教程主题并使其获得批准 确定教程主题并使其获得批准。 检查边栏导航结构并使其获得批准
第 2 周：构建教程模板并使其获得导师的批准 创建用于托管教程的教程着陆页
第 3、4、5 周：添加视频教程演示不同的模拟器工作流
第 6、7、8、9 周：为不同的简单和复杂电路创建教程
第 10 周：重新调整边栏导航结构以确保一致性，以改善用户入门体验
第 11 周：校对我的作业，检查拼写错误和错误。
相关 CircuitVerse 工作示例
*访问此链接查看示例教程：构建七段解码器。：https://pragatijain.github.io/electricverse/index.html
*此处提供了有关如何使用组合分析工具的视频教程示例链接：https://www.youtube.com/watch?v=7FkeqBYcd1w 备注 1：本视频展示了现有内容的示例，旨在展示如何使用注释功能来打造一致的视频风格。 备注 2：当我开始为 GDevelop 工作时，会购买软件许可，最终产品不会带有水印。
*CircuitVerse 教程着陆页 https://docs.google.com/document/d/1sBKS2cq76zRHDGgA2Lbf7isSisRK_ELLSPsg-7atCAI/edit#
*以 Google 文档的形式查看完整的提案：https://docs.google.com/document/d/1vzYyDnX6mFXXByrcwVsrxCgpIWKpcj8U8DSa3gVB7RA/edit#
示例教程模板：7 段解码器 7 段解码器
概述：
本教程将与您分享使用 CircuitVerse 创建 7 段解码器的不同步骤。 解码器是一种组合电路，可将二进制数转换为相应的十进制数。它接受四位输入，有七个输出。
设计过程
要在 CircuitVerse 中生成 7 段显示电路，我们将按照以下步骤操作：使用 CircuitVerse 模拟器中提供的组合分析工具构建真值表。使用此真值表，我们将在模拟器中生成电路。该电路将输出到七段 LED 显示屏。将组合电路的相应标签连接到七段 LED 显示屏的相应输出，以查看实际运行中的电路。七段显示屏是一种电子显示设备，可显示 0 到 9 之间的十进制数字。请参阅 使用真值表数据分析电路行为。 事实表 下面的表 1 列出了 7 段解码器的不同输入组合的不同输出。
CircuitVerse 元素列表
表 2 列出了实现该线路所需的不同组件。
制定事实表
按照以下步骤在 CircuitVerse 模拟器中构建真值表：
完成赛道
请参考图 10，将组合电路相应标签的相应输入线连接到七段显示屏的相应输出，从而完成该电路。 此视频演示了在 CircuitVerse 模拟器中构建的 7 段解码器模拟电路。视频链接：https://www.youtube.com/embed/tGTy4P-RxP0
分析电路
切换不同的输入值（S3、S2、S1、S0）并验证真相表（请参阅表 1），以验证已实现的七段解码器电路。
一个七段式显示屏组件包含 8 个 LED 灯段，并且它们的一端从模块中拉出，如图 8 所示。要使特定区段的 LED 发光，必须使相关区段（在图 10 中标记为 a、b、c、d、e、f、g）接通电源，以表示 0 到 9 之间的数字。例如，为了显示数字 1，LED 灯 b 和 c 必须接通电源。
如果 LED 灯未能显示正确的十进制数，请参阅表 3 和图 10，排查线路连接问题。表 3 列出了 7 个细分的显示屏引脚配置。