프레젠테이션

이 문서는 학생이 CLI를 사용하는지 에디터를 사용하는지에 따라, 다양한 연습 문제 파일과 트랙 파일이 학생에게 어떻게 표시되는지 설명해요.

문서

연습 문제에 어떤 문서가 표시되는지를 결정하는 문서 유형은 세 가지예요.

연습 문제별 파일

다음 파일은 각 연습 문제에만 해당해요:

  • .docs/introduction.md: 학생에게 연습 문제가 가르치는 개념을 소개해요 (필수)
  • .docs/introduction.append.md: 기존 소개 글 뒤에 덧붙이는 추가 소개 텍스트예요 (개념 연습 문제에서는 사용하지 않고, 실습 연습 문제에서는 선택 사항이에요)
  • .docs/instructions.md: 연습 문제의 지시 사항을 제공해요 (필수)
  • .docs/instructions.append.md: 기존 지시 사항 뒤에 덧붙이는 추가 소개 텍스트예요 (개념 연습 문제에서는 사용하지 않고, 실습 연습 문제에서는 선택 사항이에요)
  • .docs/hints.md: 학생이 연습 문제에서 막혔을 때 스스로 벗어날 수 있도록 힌트를 제공해요 (개념 연습 문제에서는 필수, 실습 연습 문제에서는 선택 사항이에요)
  • .meta/config.json: 연습 문제의 출처 정보를 담고 있어요 (선택 사항)

자세한 내용은 개념 연습 문제 문서와 실습 연습 문제 문서를 참고해요.

트랙별 파일

다음 파일은 모든 연습 문제가 함께 사용해요:

  • debug.md: 브라우저에서 코딩하는 학생이 어떻게 "디버깅"을 할 수 있는지 설명해요 (선택 사항)
  • help.md: 도움을 받는 방법에 대한 트랙별 지시 사항을 담고 있어요 (필수)
  • representations.md: 풀이의 표현을 만들기 위해 어떤 정규화가 적용되는지 설명해요 (선택 사항)
  • tests.md: 테스트를 실행하는 방법에 대한 트랙별 지시 사항을 담고 있어요 (필수)

자세한 내용은 공유 파일 문서를 참고해요.

Exercism 전체 문서

지금까지 살펴본 트랙별/연습 문제별 문서 파일 외에도, Exercism 전체에 적용되는(따라서 모든 트랙에서 공유되는) 두 가지 문서가 있어요:

  • CLI를 사용해 연습 문제를 제출하는 방법에 대한 안내
  • 도움을 받는 방법에 대한 안내

에디터

브라우저에서 연습 문제를 풀 때는 문서 파일이 적절한 시점에 표시돼요. 예를 들어, 힌트는 학생이 표시를 요청하지 않는 한 나타나지 않아요. 에디터는 CLI 안내를 표시할 필요도 없어요.

CLI

CLI로 로컬에서 작업할 때는 문서를 조건부로 표시할 방법이 없어요. 따라서 CLI는 항상 관련 문서를 모두 내려받아야 해요. 학생이 여러 파일을 열지 않아도 되도록, CLI는 관련 문서를 모두 이어 붙여 세 개의 문서로 만들어요:

README.md

이 파일에는 연습 문제의 지시 사항, 소개(선택 사항), 출처 정보(선택 사항)가 담겨 있어요.

# [exercise name]

Welcome to [exercise name] on Exercism's [track name] Track.
If you need help running the tests or submitting your code, check out `HELP.md`.
If you get stuck on the exercise, check out `HINTS.md`, but try and solve it without using those first :)

## Introduction (optional)

[Exercise-specific file: .docs/introduction.md] (optional)

[Exercise-specific file: .docs/introduction.append.md] (optional)

## Instructions

[Exercise-specific file: .docs/instructions.md]

[Exercise-specific file: .docs/instructions.append.md] (optional)

## Source

### Created by

- @[author-1 handle]
- @[author-2 handle]
  ...

### Contributed to by (optional)

- @[contributor-1 handle]
- @[contributor-2 handle]
  ...

### Based on

[source] - [source url]

HELP.md

이 파일은 테스트를 실행하는 방법과 트랙별, Exercism 전체 도움말 안내를 설명해요.

# Help

## Running the tests

[Track-specific file: exercises/shared/.docs/tests.md]

## Submitting your solution

[Exercism-wide documentation: instructions on how to submit a solution]

## Need to get help?

[Exercism-wide documentation: instructions on how to get help]

[Track-specific file: exercises/shared/.docs/help.md]

HINTS.md

이 파일에는 연습 문제별 힌트가 담겨 있어요 (선택 사항)

# Hints

## General

- Consider extracting the logic to a helper function.