本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- CircuitVerse
- 技術文件撰寫者：
- Pragati
- 專案名稱：
- 使用者說明文件與指南
- 專案長度：
- 標準長度 (3 個月)
Project description
進一步分析目標對象和目前可用的使用者說明文件後，我提議進行以下文件工作：
1) 新增影片教學課程，展示熱門的工作流程並改善新手上路體驗。影片只會概述一個概念。在影片中執行這個動作時，系統會提供影片指示。
您可以在這裡找到有關使用組合分析工具的範例影片連結。https://www.youtube.com/watch?v=7FkeqBYcd1w 注意事項 1：這部影片以現有內容為主，但用意是讓您瞭解如何使用註解，打造出一致的影片風格。注意 2：我開始處理 CircuitVerse 時，會購買軟體授權，且最終產品不會有浮水印。
以下為教學影片工作流程建議的主題： -- 開始使用 CircuitVerse：觀看這部教學影片，快速瞭解週遊流程 -- 使用組合分析工具：觀看這部教學影片，瞭解如何使用 Truth 資料表資料產生電路。 --匯出高解析度圖片：觀看這部教學影片，瞭解如何以多種格式匯出高解析度的電路影像 --使用適用於結構化設計的分路：觀看以下教學影片，瞭解如何建立分路，簡化複雜電路的結構 --使用 Hex-Bin-Dec Convertor Tool：觀看這部教學影片，瞭解如何使用 Hex-Bin-Dec 轉換器設計工具。 --視覺化呈現特定電路的電路時間圖：請觀賞這部教學影片，瞭解使用者如何以視覺化方式呈現特定電路的電路時間圖。
部分影片教學課程可以連結至網頁和使用者說明文件。
2) 建立教學課程到達網頁，簡單介紹 CircuitVerse 平台，並提供各種工作流程的圖形檢視畫面。使用者將前往 GitHub 循環瀏覽網站上的教學課程到達網頁，其中概略說明針對不同內容工作流程提供的各種教學課程。如此一來，使用者就能查看及選擇符合需求的教學課程。以下是教學課程到達網頁頁面結構的粗略範例。
3) 建立逐步教學課程，教導使用者如何使用工具學習及分析基本和複雜的電路行為 (透過工具教學)。我建議參考 CircuitVerse 精選專案，建議至少加入 5 堂教學課程，方便初級和中級使用者改善新手上路體驗。每個教學課程都會透過說明完整工作流程來介紹，接著提供設計流程、元件清單、逐步說明和練習練習的簡介。如果工作流程複雜，影片將會介紹整體概念的個別部分。
請前往這個連結查看範例教學課程：建立 Seven Segment 解碼器：https://pragatijain.github.io/Loopverse/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 週：校對作業是否有錯字和錯誤。
相關循環工作範例
*請前往這個連結觀看範例教學課程：建立 Seven 區隔解碼器。：https://pragatijain.github.io/Loopverse/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 個位元，並有七個輸出內容
設計程序
對於 CircuitVerse 中產生 7 個線段顯示電路，我們會遵循以下步驟：使用 CircuitVerse 模擬工具中的組合分析工具，繪製真值表格。接著，使用這個 Truth 資料表，在模擬器中產生電路。這個電路將輸出至七個區段的 LED 顯示幕。將混合電路的各標籤連結至七個分段 LED 顯示幕的個別結果，看看電路的實際運作情形。七段顯示螢幕是一種電子顯示裝置，顯示從 0 到 9 的十進位數字。請使用真值資料表資料來分析電路行為。下方的真值表 1 列出了 7 個片段解碼器的不同輸入組合的不同輸出內容。
CircuitVerse 元素清單
表 2 列出了實作連線所需的不同元件。
畫出真相表
請按照下列步驟，在 CircuitVerse 模擬工具中繪製真值表格：
完成電路
請參閱圖 10，將組合電路對應標籤的個別輸入線連接至 7 個線段顯示器的個別輸出內容，完成電路。這部影片展示 7 個使用 CircuitVerse 模擬工具建立的模擬解碼器模擬電路。影片連結：https://www.youtube.com/embed/tGTy4P-RxP0
分析循環
切換不同的輸入值 (S3、S2、S1、S0) 並驗證 Truth 資料表 (請參閱表 1)，確認已實作的七段式解碼器電路。
7 個線段顯示元件內含 8 個 LED 線段，並從模組中取出一端圖釘，如圖 8 所示。如要讓特定線段的 LED 燈發亮，相關線段 (標示為 a、b、c、d、e、f、g、f、例如，如：圖 10) 的電源必須亮起，以代表介於 0 到 9 之間的數字。舉例來說，如要顯示數字 1，LED b 和 c 必須充滿電。
如果 LED 無法顯示正確的小數位數，請參閱表 3 和圖 10 解決接線問題。表 3 列出 7 個線段顯示 PIN 碼設定。