본문으로 건너뛰기

샘플 튜토리얼 구조

소개​

소개 제목은 반드시 H2로 해야 합니다: ## 소개

이 섹션에서는 이 튜토리얼의 배경과 중요성, 우리가 이 튜토리얼에서 만들고 배울 것들에 대해 설명합니다.

  • 마치 5살 아이에게 설명하듯이 이 섹션을 설명하세요 (ELI5).
  • 모든 내용을 최대 5~6줄로 설명하세요.

*예시: *

스마트 컨트랙트는 TON 블록체인에서 실행되는 컴퓨터 프로그램입니다. 더 구체적으로 말하면, TVM(TON 가상 머신) 에서 실행됩니다. 이 컨트랙트는 코드(컴파일된 TVM 명령어) 와 데이터(영구 상태) 로 구성되며, TON의 특정 주소에 저장됩니다.

전제 조건​

사전 준비 제목은 반드시 H2로 해야 합니다: ## 사전 준비

이 섹션에서는 필요한 사전 지식이나 먼저 완료해야 하는 기존 튜토리얼에 대해 설명합니다. 필요한 토큰도 이곳에 언급합니다.

*예시: *

이 튜토리얼에서는 테스트넷에서 Jetton을 발행할 것입니다. 계속하기 전에 testnet 지갑에 충분한 잔액이 있는지 확인하시기 바랍니다.

요구 사항​

요구 사항 제목은 반드시 H2로 해야 합니다: ## 요구 사항

선택 사항 : 튜토리얼에 동영상 콘텐츠가 있는 경우 이 섹션에 삽입하세요.

튜토리얼을 시작하기 전에 설치해야 하며 튜토리얼에서 다루지 않는 기술(TON 월렛 확장, 노드 등) 을 설명합니다. 튜토리얼 동안 설치할 패키지는 나열하지 않습니다.

*예시: *

  • 이 튜토리얼에서는 TON 지갑 확장 프로그램이 필요하므로 여기에서 설치하세요.
  • NodeJS 12.0.1+가 설치되어 있는지 확인하세요.

튜토리얼 본문​

  • "튜토리얼 본문"을 제목으로 사용하지 말고, 자료와 관련된 제목을 사용하세요.
    • 다른 것이 생각나지 않으면 "시작하기"를 사용해도 됩니다 😉
  • 독자들이 튜토리얼을 따라갈 수 있도록 필요한 모든 텍스트 콘텐츠를 추가하고, 제출하기 전에 철자와 문법을 교정하는 것을 잊지 마세요.
    • Grammarly는 문법 실수를 방지하는 데 도움이 되는 좋은 무료 프로그램입니다.

핵심 사항​

  • "튜토리얼 본문"을 제목으로 사용하지 마세요!

  • 모든 소제목은 H3로 유지하고, H4 이하로는 사용하지 마세요.

    • Markdown 문법에서는 H2 제목에 두 개의 해시마크가 사용됩니다: ##
    • H3 제목에는 세 개의 해시마크가 사용됩니다: ###

  • 코드 블록에 필요한 주석만 추가하세요. 터미널 입력 코드 블록에 # 스타일 주석을 추가하지 마세요.

  • 관련된 모든 코드 블록을 추가하세요:

    • Markdown 문법에서 코드 블록은 코드 블록 시작과 끝에 세 개의 백틱을 사용합니다. 또한, 모든 코드 블록 앞뒤에 줄 바꿈이 있어야 합니다. 예시:​

      `js
      const testVariable = 'some string';
      someFunctionCall();
      `

    • 모든 코드 블록은 구문 강조 유형을 반드시 가져야 합니다. 확실하지 않은 경우 ```text를 사용하세요.

    • 터미널 출력, 터미널 명령 및 일반 텍스트에는 \\`text를 사용해야 합니다.

    • `javascript 또는 `js는 JavaScript 코드에 사용합니다.

    • `typescript 또는 `ts는 TypeScript 코드에 사용합니다.

    • \\`jsx는 ReactJS 코드에 사용합니다.

    • \\`cpp는 Func 코드에 사용합니다.

    • GraphQL 구문 강조에는 \\`graphql을 사용하세요.

    • 유효한 JSON을 강조할 때는 `json을 사용합니다. (유효하지 않은 JSON 예제에는 대신 `text를 사용하세요.)

    • \\`bash는 # 스타일 주석이 필요한 코드 블록에서만 사용해야 합니다. 이는 많은 상황에서 # 문자가 Markdown 제목으로 렌더링될 수 있기 때문에 신중히 사용해야 합니다. 일반적으로, 목차가 이로 인해 영향을 받습니다.

  • 강조를 위해 미리 서식을 지정한 텍스트를 사용하지 말고, 대신 굵은 글씨나 기울임꼴 텍스트만 사용하세요.

  • 예상되는 터미널 출력을 반영하기 위해 이미지나 코드 블록을 추가하세요.

  • 튜토리얼을 작성할 때는 오류 중심 접근 방식을 취하세요. 일반적인 오류와 문제 해결 단계를 추가하세요. 예시:

node deploy:testnet 명령을 실행할 때 발생하는 오류로 인해 테스트넷에 연결할 수 없습니다.

몇 가지 일반적인 원인을 살펴보겠습니다:

  • .env에 생성된 테스트넷 지갑에 충분한 자금이 있는지 확인하세요. 그렇지 않으면, faucet 제공자에서 테스트넷 코인을 추가하세요.
  • 여전히 같은 문제가 발생하면 개발자 채팅에서 개발자에게 도움을 요청하세요.

결론​

결론 제목은 반드시 H2로 해야 합니다: ## 결론

이 섹션에서는 튜토리얼에서 배운 내용을 요약하고, 핵심 사항을 강조하며, 학습자가 튜토리얼을 완료한 것을 축하해야 합니다. 최대 5–6줄로 작성합니다. 예시:

우리는 카운터 기능이 있는 새로운 간단한 FunC 컨트랙트를 만들었습니다. 그런 다음 이를 온체인에 구축하고 배포했으며, 마지막으로 getter를 호출하고 메시지를 보내 상호작용했습니다.

이 코드는 프로덕션용이 아닙니다. 메인넷에 배포하려면 토큰이 시장에 상장된 경우 전송 메서드를 비활성화하는 등 고려해야 할 몇 가지 사항이 더 있다는 점을 기억하시기 바랍니다.

더 보기​

더 보기 제목은 반드시 H2로 해야 합니다: ## 더 보기

이 섹션에서는 이 튜토리얼 후에 계속 학습할 수 있는 방법을 설명합니다. 이 튜토리얼과 관련된 프로젝트와 기사도 자유롭게 추천하세요. 진행 중인 다른 고급 튜토리얼이 있다면 간단히 언급할 수 있습니다. 일반적으로 docs.ton.org의 관련 페이지만 여기에 배치됩니다.

저자 소개 (선택 사항)​

저자 소개 제목은 반드시 H2로 해야 합니다: ## 저자 소개

짧게 작성하세요. 한 두 줄 정도면 충분합니다. GitHub 프로필 + Telegram 프로필 링크를 포함할 수 있습니다. 여기에 LinkedIn이나 Twitter를 추가하지 마세요.

참조 (선택 사항)​

참조 제목은 반드시 H2로 해야 합니다: ## 참조

다른 문서, GitHub 리포지토리 또는 기존 튜토리얼에서 도움을 받은 경우 이 섹션을 추가해야 합니다.

가능한 경우 문서 이름과 링크를 추가하여 출처를 표시하세요.

디지털 문서가 아닌 경우 ISBN 또는 다른 형태의 참고 자료를 포함하세요.