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