이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- CircuitVerse
- 기술 문서 작성자:
- Pragati
- 프로젝트 이름:
- 사용자 문서 및 가이드
- 프로젝트 길이:
- 표준 기간 (3개월)
Project description
잠재고객과 현재 사용 가능한 사용자 문서를 심층 분석한 결과 다음과 같은 문서 작업을 제안합니다.
1) 인기 있는 워크플로를 보여주고 온보딩 환경을 개선하는 동영상 튜토리얼을 추가합니다. 동영상에서는 하나의 개념을 간략히 설명합니다. 동영상에서는 화면에서 해당 작업을 실행하는 동안 안내를 제공합니다.
조합 분석 도구 사용에 관한 샘플 동영상 튜토리얼 링크는 다음과 같습니다. https://www.youtube.com/watch?v=7FkeqBYcd1w 참고 1: 이 동영상은 기존 콘텐츠를 예시로 보여주지만 주석을 사용하여 일관된 동영상 스타일을 만드는 방법을 보여주기 위한 것입니다. 참고 2: CircuitVerse에서 작업을 시작하면 소프트웨어 라이선스를 구매할 예정이며 최종 제품에는 워터마크가 포함되지 않습니다.
동영상 튜토리얼 워크플로에 추천되는 주제: --CircuitVerse 시작하기: 이 동영상 튜토리얼을 시청하여 CircuitVerse를 빠르게 둘러보세요. --조합 분석 도구 사용하기: 이 동영상 튜토리얼을 시청하여 진리표 데이터를 사용하여 회로를 생성하는 방법을 알아보세요. --고해상도 이미지 내보내기: 이 동영상 튜토리얼을 시청하여 회로의 고해상도 이미지를 여러 형식으로 내보내는 방법을 알아보세요. --구조화된 설계용 하위 회로 사용: 이 동영상 튜토리얼을 시청하여 복잡한 회로의 구조를 단순화하기 위해 하위 회로를 만드는 방법을 알아보세요. --Hex-Bin-Dec 변환 도구 사용: 이 동영상 튜토리얼을 시청하여 회로 설계 및 구현에 Hex-Bin-Dec 변환 도구를 사용하는 방법을 알아보세요. --특정 회로의 회로 타이밍 다이어그램 시각화: 이 동영상 자습서를 보고 사용자가 주어진 회로의 회로 타이밍 다이어그램을 시각화하는 방법을 알아보세요.
일부 동영상 튜토리얼은 웹페이지와 사용자 문서 간에 서로 연결될 수 있습니다.
2) CircuitVerse 플랫폼에 대한 간략한 개요를 제공하고 다양한 워크플로를 그래픽으로 보여주는 튜토리얼 방문 페이지를 만듭니다. 사용자는 Circuitverse GitHub 사이트의 튜토리얼 방문 페이지에 액세스하여 다양한 콘텐츠 워크플로에 제공되는 다양한 튜토리얼의 개요를 간략하게 확인할 수 있습니다. 이를 통해 사용자는 필요에 따라 다양한 튜토리얼을 보고 선택할 수 있습니다. 다음은 튜토리얼 방문 페이지의 페이지 구조에 관한 대략적인 샘플입니다.
3) 단계별 튜토리얼을 만들어 기본 회로와 복잡한 회로의 동작을 배우고 분석하는 방법을 사용자에게 교육합니다. 도구를 사용해 보면서 도구를 가르칩니다. CircuitVerse 추천 프로젝트를 참고하여 온보딩 환경을 개선하기 위해 초보자 및 중급 사용자를 위한 튜토리얼을 5개 이상 추가할 것을 제안합니다. 각 튜토리얼은 튜토리얼 소개로 시작하여 디자인 프로세스, 구성요소 목록, 단계별 안내, 연습 문제로 이어지며 전체 워크플로를 보여줍니다. 복잡한 워크플로의 경우 동영상에서 전체 컨셉의 개별 부분을 다룹니다.
샘플 튜토리얼을 보려면 이 링크를 방문하세요. 세븐 세그먼트 디코더 빌드: https://pragatijain.github.io/circuitverse/index.html
일부 주제에는 다음이 포함됩니다. --롤링 LED 디스플레이 빌드하기 --리플 캐리 더하기의 작동 방식 살펴보기 --1A단계: 4비트 크기 비교기 분석하기 --1B단계: 16진수 계산기 빌드하기 --유한 상태 머신 (FSM) 구현 분석하기
4) 일관성, 가독성, 응집력을 개선하기 위해 사이드바 탐색의 구조를 수정했습니다.
프로젝트 도구 1) 동영상 튜토리얼용 Camtasia 샘플 동영상을 만들기 위해 평가판 버전을 사용했습니다. CircuitVerse에서 근무하기 시작할 때 소프트웨어 라이선스를 구매할 것이며 최종 제품에 워터마크를 포함하지 않을 것입니다. 2) 가이드를 작성하기 위한 Google 문서이며 나중에 CircuitVerse 저장소에서 호스팅하도록 GitHub에서 업데이트할 예정입니다. 3) GitHub에서 내 콘텐츠를 관리하기 위한 Wiki 마크업 및 HTML
타임라인 8월 16일 이전 GitHub에서 조직에 참여합니다.
커뮤니티 결속 (8월 17일~9월 13일): 커뮤니케이션 채널과 시간을 설정합니다 (시차로 인해). 목표를 수정하고 양측의 기대치를 설정합니다. 커뮤니티 및 제품에 대해 자세히 알아보세요. 멘토 및 조직의 다른 구성원과 함께 제안된 문서 구조에 대해 논의하고 마무리합니다.
문서 작성 기간 이 프로젝트는 표준 길이 프로젝트 가이드라인 (2020년 9월 14일부터 2020년 11월 30일까지 총 11주)을 따릅니다. 아래에 설명된 목표를 달성하기 위해 일주일에 약 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 Docs로 전체 제안서 보기: https://docs.google.com/document/d/1vzYyDnX6mFXXByrcwVsrxCgpIWKpcj8U8DSa3gVB7RA/edit#
샘플 튜토리얼 템플릿: 7세그먼트 디코더 7세그먼트 디코더
개요:
이 튜토리얼에서는 CircuitVerse를 사용하여 7세그먼트 디코더를 만드는 다양한 단계를 공유합니다. 디코더는 이진수를 해당하는 10진수로 변환하는 조합 회로입니다. 입력은 4비트이고 출력은 7개입니다.
설계 절차
CircuitVerse에서 7 세그먼트 디스플레이 회로를 생성하려면 다음 단계를 따릅니다. CircuitVerse 시뮬레이터 내에서 사용할 수 있는 조합 분석 도구를 사용하여 진리표를 공식화합니다. 이 진리표를 사용하여 시뮬레이터 내에서 회로를 생성합니다. 이 회로는 7세그먼트 LED 디스플레이로 출력을 구동합니다. 조합 회로의 각 라벨을 7개의 세그먼트 LED 디스플레이의 각 출력에 연결하여 회로의 작동 모습을 확인합니다. 7 세그먼트 디스플레이는 0에서 9까지의 십진수를 표시하는 전자 디스플레이 장치입니다.참조 진리표 데이터를 사용하여 회로 동작을 분석합니다. 진리표 아래 표 1에는 7세그먼트 디코더의 입력 조합에 따른 다양한 출력이 나와 있습니다.
CircuitVerse 요소 목록
표 2에는 회로 구현에 필요한 다양한 구성요소가 나와 있습니다.
정보 표 작성
CircuitVerse 시뮬레이터 내에서 진리표를 수립하려면 다음 단계를 따르세요.
회로 완성
그림 10을 참고하여 조합 회로의 해당 라벨에 대한 각 입력선을 7세그먼트 디스플레이의 각 출력에 연결하여 회로를 완성합니다. 이 동영상에서는 CircuitVerse 시뮬레이터 내에 빌드된 7세그먼트 디코더 시뮬레이션 회로를 보여줍니다. 동영상 링크: https://www.youtube.com/embed/tGTy4P-RxP0
회로 분석
다양한 입력 값 (S3, S2, S1, S0)을 전환하고 진리표 (표 1 참고)를 검증하여 구현된 7세그먼트 디코더 회로를 확인합니다.
7세그먼트 디스플레이 구성요소는 내부에 8개의 LED 세그먼트가 있으며 핀의 한쪽 끝이 모듈에서 분리되어 있습니다(그림 8 참고). 특정 세그먼트의 LED를 켜려면 관련 세그먼트 (그림 10에서 a, b, c, d, e, f, g로 라벨이 지정됨)에 전원을 공급하여 0~9의 숫자를 나타내야 합니다. 예를 들어 숫자 1을 표시하려면 LED b와 c의 전원이 켜져 있어야 합니다.
LED에 올바른 십진수가 표시되지 않으면 표 3과 그림 10을 참고하여 배선 연결 문제를 해결합니다. 표 3에는 7세그먼트 디스플레이 핀 구성이 나와 있습니다.