Trang này được dịch bởi Cloud Translation API.

Dự án CircuitVerse

Trang này chứa thông tin chi tiết về một dự án viết nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.

Tóm tắt dự án

Tổ chức nguồn mở:: CircuitVerse
Người viết nội dung kỹ thuật:: Pragati
Tên dự án:: Tài liệu và hướng dẫn dành cho người dùng
Thời lượng dự án:: Thời hạn tiêu chuẩn (3 tháng)

Mô tả dự án

Sau khi phân tích chuyên sâu về đối tượng và tài liệu người dùng hiện có, tôi đề xuất các tác vụ tài liệu dưới đây:

1) Thêm video hướng dẫn để minh hoạ các quy trình công việc phổ biến và cải thiện trải nghiệm làm quen. Video sẽ trình bày một khái niệm duy nhất. Video sẽ đưa ra hướng dẫn trong khi thực hiện hành động đó trên màn hình.

Bạn có thể xem video hướng dẫn mẫu về cách sử dụng Công cụ phân tích kết hợp tại đây. https://www.youtube.com/watch?v=7FkeqBYcd1w Lưu ý 1: Mặc dù video này minh hoạ nội dung hiện có, nhưng mục đích của video là cho thấy cách sử dụng chú thích để tạo một phong cách video nhất quán. Lưu ý 2: Khi bắt đầu làm việc cho CircuitVerse, tôi sẽ mua giấy phép cho phần mềm và sản phẩm cuối cùng sẽ không có hình mờ.

Các chủ đề đề xuất cho quy trình làm việc của video hướng dẫn: --Bắt đầu với CircuitVerse: Xem hướng dẫn bằng video này để tham quan nhanh về CircuitVerse --Sử dụng Công cụ phân tích tổ hợp: Xem video hướng dẫn này để tìm hiểu cách tạo mạch bằng dữ liệu bảng chân thực. --Xuất hình ảnh có độ phân giải cao: Xem hướng dẫn video này để tìm hiểu cách xuất hình ảnh có độ phân giải cao của mạch ở nhiều định dạng --Sử dụng mạch con để thiết kế có cấu trúc: Xem hướng dẫn video này để tìm hiểu cách tạo mạch con nhằm đơn giản hoá cấu trúc của các mạch phức tạp --Sử dụng công cụ chuyển đổi Hex-Bin-Dec: Xem hướng dẫn video này để tìm hiểu cách sử dụng công cụ chuyển đổi Hex-Bin-Dec để thiết kế và triển khai mạch. –Hình ảnh hoá sơ đồ thời gian của mạch cho một mạch nhất định: Xem video hướng dẫn này để tìm hiểu cách người dùng có thể hình ảnh hoá sơ đồ thời gian của mạch cho một mạch nhất định.

Một số video hướng dẫn có thể được liên kết với nhau trên các trang web và tài liệu hướng dẫn người dùng.

2) Tạo trang đích hướng dẫn để cung cấp thông tin tổng quan ngắn gọn về nền tảng CircuitVerse cũng như cung cấp chế độ xem dạng biểu đồ về nhiều quy trình công việc. Người dùng sẽ truy cập vào trang đích hướng dẫn trên trang web GitHub của Circuitverse. Trang này sẽ cung cấp thông tin tóm tắt về các hướng dẫn được cung cấp cho nhiều quy trình công việc nội dung. Nhờ vậy, người dùng có thể xem và chọn các hướng dẫn khác nhau theo nhu cầu của mình. Dưới đây là một mẫu sơ lược về cấu trúc trang của trang đích hướng dẫn.

3) Tạo hướng dẫn từng bước để hướng dẫn người dùng cách sử dụng công cụ này nhằm tìm hiểu và phân tích hành vi của các mạch cơ bản và phức tạp – hướng dẫn công cụ này bằng cách chơi với công cụ. Tham khảo các dự án nổi bật của CircuitVerse, tôi đề xuất thêm ít nhất 5 hướng dẫn dành cho người dùng mới bắt đầu và người dùng cấp trung để cải thiện trải nghiệm làm quen. Mỗi hướng dẫn sẽ cung cấp phần giới thiệu, sau đó là quy trình thiết kế, danh sách thành phần, hướng dẫn từng bước và bài tập thực hành. Đối với quy trình làm việc phức tạp, video sẽ thể hiện một phần riêng lẻ của một ý tưởng tổng thể.

Truy cập vào đường liên kết này để xem hướng dẫn mẫu: Tạo bộ giải mã 7 đoạn: https://pragatijain.github.io/circuitverse/index.html

Một số chủ đề bao gồm: --Tạo màn hình LED cuộn --Khám phá cách hoạt động của bộ cộng có tính năng cộng tràn (ripple carry) --Phần 1A: Phân tích bộ so sánh độ lớn 4 bit --Phần 1B: Tạo máy tính thập lục phân --Phân tích cách triển khai máy trạng thái hữu hạn (FSM)

4) Sửa đổi cấu trúc của thanh điều hướng bên để cải thiện tính nhất quán, khả năng đọc và tính nhất quán.

Công cụ dự án 1) Camtasia để tạo video hướng dẫn. Tôi đã sử dụng phiên bản dùng thử để tạo video mẫu. Khi bắt đầu làm việc cho CircuitVerse, tôi sẽ mua giấy phép cho phần mềm này và sản phẩm cuối cùng sẽ không có hình mờ. 2) Google docs để viết hướng dẫn. Sau này, tôi sẽ cập nhật hướng dẫn trong GitHub để lưu trữ trong kho lưu trữ CircuitVerse. 3) Mã đánh dấu Wiki và HTML để quản lý nội dung của tôi trong GitHub.

Tiến trình Trước ngày 16 tháng 8 Đóng góp cho tổ chức trên GitHub.

Gắn kết cộng đồng (17/8 – 13/9) Thiết lập kênh và thời gian liên lạc (do chênh lệch múi giờ). Tinh chỉnh mục tiêu và đặt kỳ vọng cho cả hai bên. Tìm hiểu thêm về cộng đồng và sản phẩm. Thảo luận và hoàn thiện cấu trúc tài liệu được đề xuất với cố vấn và các thành viên khác của tổ chức.

Thời gian ghi nhận tài liệu Dự án này sẽ tuân theo các nguyên tắc tiêu chuẩn của dự án có thời lượng dự án tiêu chuẩn (tổng cộng 11 tuần, từ ngày 14/9/2020 đến ngày 30/11/2020). Tôi sẽ dành khoảng 20 giờ mỗi tuần để hoàn thành các mục tiêu được nêu bên dưới. Ngoài những mục tiêu này, tôi sẽ tham gia các cuộc họp cố vấn và trao đổi trong thời gian này (nếu cần). Tôi sẽ làm việc với các cố vấn để xác định thời điểm phù hợp nhất. Lưu ý: Tiến trình này linh hoạt và ghi nhận thực tế là nhu cầu của tổ chức có thể thay đổi. Khung thời gian lớn cho phép linh hoạt và khả năng chuyển đổi tiêu điểm khi cần.

Tuần 1: Xem lại các mốc đã xác định và điều chỉnh các mốc đó Fork kho lưu trữ CircuitVerse và tải xuống máy của tôi Thảo luận với các cố vấn về phong cách video, cũng như phát triển mẫu màn hình mở đầu video, bất kỳ bản nhạc nào để lấp đầy cho tiêu đề và màn hình kết thúc, cũng như thông tin bổ sung cần đưa vào. Xem lại các chủ đề hướng dẫn bằng video và yêu cầu phê duyệt Xác định các chủ đề hướng dẫn và yêu cầu phê duyệt. Xem xét và phê duyệt cấu trúc điều hướng thanh bên

Tuần 2: Tạo mẫu hướng dẫn và được người cố vấn phê duyệt Tạo trang đích hướng dẫn để lưu trữ các hướng dẫn

Tuần 3, 4, 5: Thêm video hướng dẫn để minh hoạ các quy trình làm việc khác nhau của trình mô phỏng

Tuần 6, 7, 8, 9: Tạo hướng dẫn cho nhiều loại mạch đơn giản và phức tạp

Tuần 10: Tái cấu trúc thanh điều hướng ở bên để đảm bảo tính nhất quán nhằm cải thiện trải nghiệm làm quen của người dùng

Tuần 11: Kiểm tra lỗi chính tả và lỗi trong bài viết của tôi.

Mẫu công việc liên quan trên CircuitVerse

*Truy cập vào đường liên kết này để xem hướng dẫn mẫu: Tạo bộ giải mã 7 đoạn. : https://pragatijain.github.io/circuitverse/index.html

*Bạn có thể xem đường liên kết đến video hướng dẫn mẫu về cách sử dụng Công cụ phân tích kết hợp tại đây. https://www.youtube.com/watch?v=7FkeqBYcd1w Lưu ý 1: Mặc dù video này minh hoạ nội dung hiện có, nhưng video này nhằm cho thấy cách sử dụng chú thích để tạo một phong cách video nhất quán. Lưu ý 2: Khi bắt đầu làm việc cho GDevelop, tôi sẽ mua giấy phép cho phần mềm và sản phẩm cuối cùng sẽ không có hình mờ.

*Trang đích hướng dẫn về CircuitVerse https://docs.google.com/document/d/1sBKS2cq76zRHDGgA2Lbf7isSisRK_ELLSPsg-7atCAI/edit#

*Xem toàn bộ đề xuất dưới dạng tệp Google Tài liệu: https://docs.google.com/document/d/1vzYyDnX6mFXXByrcwVsrxCgpIWKpcj8U8DSa3gVB7RA/edit#

Mẫu hướng dẫn mẫu: Bộ giải mã 7 đoạn Bộ giải mã 7 đoạn

Tổng quan:

Hướng dẫn này chia sẻ với bạn các bước để tạo bộ giải mã 7 đoạn bằng CircuitVerse. Bộ giải mã là mạch tổ hợp chuyển đổi số nhị phân thành số thập phân tương ứng. Lớp này nhận 4 bit đầu vào và có 7 đầu ra.

Quy trình thiết kế

Để tạo mạch hiển thị 7 đoạn trong CircuitVerse, chúng ta sẽ làm theo các bước dưới đây: Sử dụng công cụ Phân tích kết hợp có trong trình mô phỏng CircuitVerse để lập bảng chân lý. Sử dụng bảng chân lý này, chúng ta sẽ tạo mạch trong trình mô phỏng. Mạch này sẽ điều khiển đầu ra sang màn hình LED 7 đoạn. Kết nối các nhãn tương ứng của mạch kết hợp với các đầu ra tương ứng của màn hình LED 7 đoạn để xem mạch của chúng ta hoạt động. Màn hình 7 đoạn là một thiết bị hiển thị điện tử để hiển thị các chữ số thập phân từ 0 đến 9.Tham khảo phân tích hành vi của mạch bằng dữ liệu bảng chân lý. Bảng chân lý Bảng 1 dưới đây liệt kê các kết quả đầu ra cho các tổ hợp đầu vào khác nhau của bộ giải mã 7 đoạn.

Danh sách phần tử CircuitVerse

Bảng 2 liệt kê các thành phần cần thiết để triển khai mạch.

Xây dựng bảng chân lý

Hãy làm theo các bước dưới đây để lập bảng dữ liệu đáng tin cậy trong trình mô phỏng CircuitVerse:

Hoàn tất mạch

Tham khảo Hình 10 để kết nối các dây đầu vào tương ứng cho các nhãn tương ứng của mạch kết hợp với các đầu ra tương ứng của màn hình 7 đoạn để hoàn tất mạch. Video này minh hoạ một mạch mô phỏng bộ giải mã 7 đoạn được tạo trong trình mô phỏng CircuitVerse. Đường liên kết đến video: https://www.youtube.com/embed/tGTy4P-RxP0

Phân tích mạch

Bật/tắt các giá trị đầu vào khác nhau (S3, S2, S1, S0) và xác thực bảng chân lý (tham khảo Bảng 1) để xác minh mạch giải mã 7 đoạn đã triển khai.

Thành phần hiển thị 7 đoạn có 8 đoạn LED bên trong và một đầu của các chân được kéo ra khỏi mô-đun như minh hoạ trong Hình 8. Để làm cho LED của một phân đoạn cụ thể sáng lên, các phân đoạn liên quan (được gắn nhãn là a, b, c, d, e, f, g trong Hình 10) phải được cấp nguồn để biểu thị các số từ 0 đến 9. Ví dụ: để hiển thị số 1, đèn LED b và c phải được bật nguồn.

Nếu đèn LED không hiển thị đúng số thập phân, hãy tham khảo Bảng 3 và Hình 10 và khắc phục sự cố về kết nối đấu dây. Bảng 3 liệt kê cấu hình chân hiển thị 7 đoạn.