소개
Codelab은 마크다운 구문으로 작성된 대화형 튜토리얼입니다. Google은 blocklycodelabs.dev에 Codelab을 게시합니다. Codelab에서는 자연어, 코드 샘플, 스크린샷을 혼합하여 더 흥미로운 튜토리얼 환경을 만듭니다. Codelab의 타겟 사용자는 읽으면서 코드를 따라하고 실행합니다.
코드랩을 작성하는 것은 커뮤니티에 기여하는 좋은 방법입니다. 지식을 공유하고 동일한 문제를 겪는 다음 개발자의 작업을 더 쉽게 할 수 있습니다.
훌륭한 Codelab의 조건
훌륭한 Codelab은 집중도가 높고 읽기 쉽습니다. 사용자에게 빌드할 항목과 학습할 항목을 명확하게 알려주고 특정 작업을 완료하기 위해 코드를 작성하고 이해하는 과정을 안내합니다.
절차
Codelab에 관한 아이디어가 있으면 blockly-samples 저장소에서 기능 요청을 만들어 알려주세요. 가르치고 싶은 내용과 코드랩에서 빌드할 내용을 설명합니다. 아이디어를 논의하고 구체화합니다. 그런 다음 이를 작성하고 풀 요청을 제출할 수 있습니다. 검토를 거치면 Blockly팀의 구성원이 이를 게시합니다.
작성 시 도움말
이 페이지의 나머지 부분은 Codelab 작성을 안내하는 팁과 질문으로 구성되어 있습니다.
기술 문서 작성 1에서 기술 문서 작성에 대해 간단히 알아보세요.
잠재고객
- 타겟 독자는 누구인가요?
- Blockly 사용에 대해 이미 알고 있는 것은 무엇인가요?
- 무엇을 배우려고 하는가?
설정
- 사용자가 코드를 실행하는 데 필요한 최소 설정은 무엇인가요?
필요한 경우 examples 디렉터리에 시작 코드와 완료된 코드를 게시할 수 있습니다.
구조
다른 글쓰기와 마찬가지로 개요부터 시작하세요. 대부분의 Codelab에 적합한 구조는 다음과 같습니다.
- 소개
- 학습할 내용
- 빌드할 항목
- 알아야 할 사항
- 설정 안내
- 1단계: [여기에 제목 입력]
- 설명/동기
- 코드 샘플
- 예상 결과
- (선택사항) 추가 설명
- ...
- 10단계: [여기에 제목 입력]
- 요약
- 학습한 내용
- 빌드한 항목
- 추가 리소스
- 완성된 코드 링크 (있는 경우)
10단계 이상으로 구성할 수 있지만 20단계에 도달하면 두 개의 Codelab으로 나누는 것이 좋습니다.
작성 스타일
- 대화형 글쓰기 스타일을 사용해 줘.
- 제목을 사용하여 조직을 명확하게 합니다.
- 글머리기호 목록을 사용하여 텍스트를 구분합니다.
- 이미지와 GIF를 사용하세요.
코드 스타일
- ES5, ES6 또는 TypeScript로 작성할 수 있지만 시작 부분에 어떤 언어인지 독자에게 알려야 합니다.
- Google 스타일 가이드를 따릅니다.