本頁面包含 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 堂教學課程，協助提升新手上路體驗。每個教學課程都會說明完整的工作流程，包括教學課程簡介、設計程序、元件清單、逐步操作說明和練習題。如果是複雜的工作流程，影片會涵蓋整體概念的個別部分。
如要查看教學課程範例，請點選以下連結：建立 Seven Segment Decoder：https://pragatijain.github.io/connectionverse/index.html
部分主題包括： --建立捲動式 LED 顯示器 --探索漣漪進位加法器的運作方式 --第 1A 部分：分析 4 位元大小比較器 --第 1B 部分：建構 16 進制計算機 --分析有限狀態機器 (FSM) 實作
4) 修訂側欄導覽結構，提升一致性、易讀性和連貫性。
專案工具 1) 使用 Camtasia 製作影片教學。我使用了試用版本製作範例影片。開始為 CircuitVerse 工作時，我會購買軟體授權，最終產品不會包含浮水印。2) Google 文件，用於撰寫指南，我會稍後在 GitHub 中更新，並在 CircuitVerse 存放區中代管。3) Wiki 標記和 HTML，用於管理 GitHub 中的內容。
時間表 8 月 16 日前 在 GitHub 上為機構組織做出貢獻。
社群連結 (8 月 17 日至 9 月 13 日) 設定通訊管道和時間 (考量時差)。同時調整我的目標，同時設定雙方的期望。 進一步瞭解社群和產品。與導師和機構內其他成員討論並敲定建議的文件結構。
文件撰寫期間 這個專案將遵循標準長度的專案規範 (總共 11 週，自 2020 年 9 月 14 日至 2020 年 11 月 30 日)。我會每週花約 20 小時完成下列目標。除了這些目標之外，如有需要，我也會在這段時間內參與導師會議和溝通。我會與導師一起決定最合適的時間。 注意：這份時間表彈性較高，且考量到機構需求可能會有所變動。較大的時間範圍可讓您享有靈活彈性，並可視需要切換焦點。
第 1 週： 查看找出的里程碑並修正 Fork CircuitVerse 存放區並下載至我的電腦 與導師討論影片風格，並製作影片開場畫面範本、製作影片片頭畫面範本、標題和結尾畫面的填充音樂，以及其他應加入的資訊。 檢查影片教學主題並取得核准 標示教學主題並取得核准。 複習側欄導覽結構並獲得核准
第 2 週： 製作教學課程範本，並由導師核准 建立代管教學課程的教學課程到達網頁
第 3、4、5 週：新增示範不同模擬器工作流程的影片教學
第 6、7、8、9 週：針對不同簡單和複雜電路建立教學課程
第 10 週：調整側欄導覽面板的結構，以保持一致性，提升使用者新手上路體驗
第 11 週：校對我的作業，找出拼字和錯誤。
相關 CircuitVerse 工作範例
*請按一下這個連結，查看範例教學課程：建構七段式解碼器。：https://pragatijain.github.io/connectionverse/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 燈亮起，相關路段 (標示為 0 到 9 的數字) 必須接上電源 (標示為 a、b、c、d、e、f、g 於圖 10)。舉例來說，如要顯示 1 號，LED 燈和 c 的電源必須為開機。
如果 LED 未顯示正確的十進制數字，請參閱表 3 和圖 10，並排解接線問題。表 3 列出 7 段顯示器針腳設定。