공유 파일

일부 문서 파일은 개념 연습 문제와 실습 연습 문제 모두에 적용돼요. 이렇게 연습 문제 전반에 걸쳐 쓰이는 파일들은 트랙의 exercises/shared/.docs 디렉터리에 있어요:

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

프레젠테이션 문서는 이 파일들이 학습자에게 콘텐츠를 전달하는 데 어떻게 사용되는지 설명해요.

파일: debug.md

목적: 브라우저에서 코딩하는 학습자가 어떻게 "디버깅"을 할 수 있는지 설명해요

포함 여부: 선택 사항

브라우저 에디터에는 내장된 디버깅 지원이 없어요. 트랙의 테스트 러너가 콘솔 출력을 캡처하는 기능을 지원한다면, 학습자는 여전히 어느 정도 "디버깅"을 할 수 있고, 이 문서는 그 방법을 설명해요.

이 파일의 내용은 온라인 에디터에서만 표시돼요. CLI는 이 파일을 무시해요.

예시

# Debug

To help with debugging, you can use the fact that any [console output](https://www.programiz.com/csharp-programming/basic-input-output) will be shown in the test results window. You can write to the console using:

```csharp
Console.WriteLine("Debug message");
```

파일: help.md

목적: 학습자가 도움을 받을 수 있는 방법을 설명해요

포함 여부: 필수

학습자가 도움을 받는 방법을, Exercism 전체가 아니라 이 트랙에 특화해서 설명해요.

이 파일의 내용은 CLI에서만 사용되며, CLI는 이 파일을 HELP.md 파일에 포함시켜요.

지침은 짧고 요점만 담아야 해요.

Gitter 채널, 포럼, 메일링 리스트처럼 학습자가 막힌 문제를 풀 수 있게 도와줄 수 있는 자료라면 무엇이든 링크해도 돼요.

이 문서의 링크는 docs/LEARNING.md나 docs/RESOURCES.md의 링크와 겹칠 수 있어요.

이 문서는 Exercism 전체(트랙과 무관한) 도움말 자료로 연결되면 안 돼요. 그런 자료는 HELP.md 파일에 자동으로 포함되기 때문이에요.

예시

# Help

To get help if you're having trouble, you can use one of the following resources:

- [Kotlin Documentation](https://kotlinlang.org/docs/reference/)
- [Kotlin Forums](https://discuss.kotlinlang.org/)
- [Kotlin Slack Channel](https://kotlinlang.slack.com/): [get invite here](https://slack.kotlinlang.org/)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/kotlin)
- [Kotlin Subreddit](https://www.reddit.com/r/kotlin)

파일: representations.md

목적: 풀이에 어떤 정규화가 적용되어 리프리젠테이션이 만들어지는지 설명해요

포함 여부: 선택 사항

트랙에서 리프리젠터를 구현했다면, 제출된 모든 풀이에 대해 리프리젠테이션이 만들어져요.

이 문서에는 리프리젠터가 풀이에 적용하는 모든 정규화를 나열해야 해요.

이렇게 하면 멘토가 리프리젠테이션에 코멘트를 추가할 때 도움이 돼요.

예시

# Representations

The representer applies the following normalizations:

- All comments are removed
- All import declarations are removed
- The code is formatted
- Identifiers are normalized to a placeholder value

트랙에 docs/REPRESENTER_NORMALIZATIONS.md 파일이 있다면, 정규화 항목을 그 파일의 해당 섹션으로 링크하는 걸 권장해요.

파일: tests.md

목적: 테스트를 실행하는 방법에 대한 트랙별 지침을 담고 있어요

포함 여부: 필수

이 특정 연습 문제의 테스트를 실행하는 방법을 설명해요.

이 파일의 내용은 CLI에서만 사용되며, CLI는 이 파일을 HELP.md 파일에 포함시켜요.

지침은 짧고 요점만 담아야 해요.

docs/TESTS.md 파일에는 테스트 실행 방법에 대한 더 자세한 설명을 담을 수 있어요.

예시

# Tests

To run the tests, run the command `dotnet test` from within the exercise directory.

덮어쓰기

참고: 아직 구현되지 않았어요

연습 문제는 연습 문제의 .docs 디렉터리에 같은 이름의 파일(예: .docs/debug.md)을 만들어 트랙별 파일을 덮어쓸 수 있어요. 이게 필요한 경우는 거의 없어야 해요(있더라도 정말 드물어야 해요).