튜토리얼 구조 샘플
소개
소개 제목은 H2: '## 소개'여야 합니다.
이 섹션에서는 이 튜토리얼의 맥락과 이것이 왜 중요한지, 이 튜토리얼에서 무엇을 만들고 배울 것인지 설명합니다.
- 이 섹션을 5세 어린이에게 설명하듯 설명하세요(ELI5).
- 모든 내용을 최대 5~6줄로 설명하세요.
*예시: *
스마트 컨트랙트는 TON 블록체인에서 실행되는 컴퓨터 프로그램, 더 구체적으로 말하면 TVM(TON 가상 머신)에서 실행되는 컴퓨터 프로그램입니다. 컨트랙트는 TON의 특정 주소에 저장된 코드(컴파일된 TVM 명령어)와 데이터(영구 상태)로 구성됩니다.
전제 조건
필수 조건 제목은 H2: ## 필수 조건
이어야 합니다.
이 섹션에서는 필요한 사전 지식이나 먼저 완료해야 하는 기존 튜토리얼을 설명할 수 있습니다. 필요한 토큰이 있으면 여기에 언급하세요.
*예시: *
이 튜토리얼에서는 테스트넷에서 제튼을 발행해 보겠습니다. 계속하기 전에 testnet 지갑에 충분한 잔액이 있는지 확인하시기 바랍니다.
요구 사항
요구 사항 제목은 H2: ## 요구 사항
이어야 합니다.
선택 사항 : 튜토리얼에 동영상 콘텐츠가 있는 경우 이 섹션에 동영상 콘텐츠를 삽입하세요.
튜토리얼을 시작하기 전에 설치해야 하며 튜토리얼에서 다루지 않는 기술(TON 월렛 확장
, 노드
등). 튜토리얼 중에 설치될 패키지는 나열하지 마세요.
*예시: *
- 이 튜토리얼에서는 TON 지갑 확장 프로그램이 필요하므로 여기에서 설치하세요.
- NodeJS 12.0.1+가 설치되어 있는지 확인하세요.
튜토리얼 본문
- '튜토리얼 본문'을 제목으로 사용하지 마시고 자료와 관련된 자신만의 제목을 사용하세요.
- "다른 생각이 떠오르지 않는다면 '시작하기'도 괜찮습니다 😉.
- 튜토리얼을 독자에게 안내하는 데 필요한 텍스트 콘텐츠를 추가하고, 튜토리얼을 제출하기 전에 철자와 문법에 대해 콘텐츠***를 교정하는 것을 잊지 마세요.
- Grammarly는 문법 실수를 방지하는 데 도움이 되는 좋은 무료 프로그램입니다.
핵심 사항
"튜토리얼 본문"을 제목으로 사용하지 마세요!
**모든 소제목은 H3로 유지하고, H4 이하로 내려가지 마세요.
- 마크다운 구문에서는 H2 제목에 두 개의 해시마크가 사용됩니다: ##
- H3 제목에는 3개의 해시마크가 사용됩니다: ###
코드 블록에 필요한 주석만 추가하세요. ***터미널 입력 코드 블록에 # 스타일 주석을 추가하지 마세요.
모든 관련 코드 블록을 추가합니다:
코드 블록의 마크다운 구문은 코드 블록의 시작과 끝에 세 개의 백틱으로 구성됩니다. 또한 모든 코드 블록의 백틱 앞뒤에 새 줄이 있는지 확인하세요. 예시:
`js
const testVariable = '일부 문자열';
someFunctionCall();
`모든 코드 블록에는 구문 강조 표시 유형이 *** 있어야 합니다. 확실하지 않은 경우 ```텍스트를 사용하세요.
터미널 출력, 터미널 명령 및 일반 텍스트에는 \
\
`텍스트를 사용해야 합니다.\자바스크립트 또는 ```js는 모든 자바스크립트 코드에 사용할 수 있습니다.
\타입스크립트 또는 ```ts는 모든 타입스크립트 코드에 사용할 수 있습니다.
\
\
`jsx는 ReactJS 코드용입니다.\
\
`cpp는 함수 코드용입니다.GraphQL 구문을 강조 표시할 때는 \
\
`graphql을 사용합니다.유효한 JSON을 강조 표시할 때는 `json을 사용합니다. (유효하지 않은 JSON 예제에는 `text를 대신 사용합니다.)
\bash는 # 스타일 주석이 필요한 코드 블록에서만 만 사용해야 합니다. 많은 상황에서 # 문자가 마크다운 제목으로 렌더링되므로 이 작업은 신중하게 수행해야 합니다. 이 경우 일반적으로 목차가 영향을 받습니다.
강조를 위해 '미리 서식이 지정된 텍스트'를 사용하지 말고, 굵은체 또는 이탤릭체 텍스트만 사용하세요.
예상 터미널 출력을 반영하는 이미지 또는 코드 블록을 추가합니다.
튜토리얼을 작성할 때는 오류 중심 접근 방식을 취하세요. 일반적인 오류와 문제 해결 단계를 추가하세요. *예: *다음 예시
**
node deploy:testnet
명령 실행 시 오류로 인해 테스트넷에 연결할 수 없습니다.**몇 가지 일반적인 원인을 살펴보겠습니다:
- 생성된 테스트넷 지갑에 '.env'에 충분한 자금이 있는지 확인하세요. 그렇지 않다면 수도꼭지 제공자로부터 테스트넷 코인을 추가해 주세요.
- 여전히 같은 문제가 발생하면 개발자 채팅에서 개발자에게 도움을 요청하세요.
결론
결론 제목은 H2: ## 결론
이어야 합니다.
이 섹션에서는 튜토리얼에서 학습한 내용을 요약하고, 핵심 사항을 강조하며, 학습자가 튜토리얼을 완료한 것을 축하해야 합니다. 최대 5~6줄로 작성합니다. 예시:
카운터 기능을 갖춘 간단한 새 FunC 컨트랙트를 만들었습니다. 그런 다음 이를 온체인에 구축 및 배포하고, 마지막으로 겟터를 호출하고 메시지를 전송하여 상호 작용했습니다.
이 코드는 프로덕션용이 아니며, 토큰이 마켓에 상장된 경우 전송 방법을 비활성화하는 등 메인넷에 배포하려면 고려해야 할 사항이 몇 가지 더 있다는 점을 기억하시기 바랍니다.
참고 항목
다음 단계 제목은 H2: ## 참조
이어야 합니다.
이 섹션에서는 이 튜토리얼 이후 학습을 계속하기 위해 다음에 수행할 수 있는 작업에 대해 설명합니다. 이 튜토리얼과 관련된 추천 프로젝트와 문서를 자유롭게 추가하세요. 다른 고급 자습서를 작업 중인 경우에는 여기에 간략하게 언급할 수 있습니다. 일반적으로 docs.ton.org의 관련 페이지만 여기에 배치됩니다.
저자 소개 (선택 사항)
저자 소개 제목은 H2: '### 저자 소개'여야 합니다.
짧게 작성하세요. 한 두 줄 정도면 충분합니다. GitHub 프로필 + 텔레그램 프로필 링크를 포함할 수 있습니다. 여기에 링크드인이나 트위터를 추가하지 마세요.
참조 (선택 사항)
참조 제목은 H2: ## 참조
이어야 합니다.
이 튜토리얼을 작성하는 데 다른 문서, GitHub 리포지토리 또는 기존 튜토리얼에서 도움을 받았다면 이 섹션이 필수입니다.
가능한 경우 문서에 이름과 링크를 추가하여 신용 출처를 표시합니다.
디지털 문서가 아닌 경우 ISBN 또는 기타 참조 형식을 포함하세요.