# 소개

# 쿡북 vs 가이드

레시피와 가이드는 무엇이 다릅니까? 왜 이것이 필요한가요?

  • 더 큰 초점(Greater Focus): 가이드에서 우리는 본질적으로 이야기를 하고 있습니다. 각 섹션은 이전 섹션의 지식을 기반으로 하고 이를 가정합니다. 쿡북에서 각 레시피는 자체적으로 존재할 수 있고, 존재해야합니다. 이는 레시피가 일반적인 개요를 제공하지 않고 Vue의 특정 측면을 집중 할 수 있음을 의미합니다.

  • 더 큰 깊이(Greater Depth): 가이드가 너무 길어지지 않도록 각 기능을 이해하는 데 도움이 되는 가장 간단한 예만 포함하려고 합니다. 그런다음 계속 진행합니다. 쿡북에서는 흥미로운 방식으로 기능을 결합하여 더 복잡한 예제를 포함할 수 있습니다. 각 레시피는 가이드의 틈새를 완전히 탐색하기 위해 필요한만큼 길고 상세할 수도 있습니다.

  • 자바스크립트 교육(Teaching JavaScript): 이 가이드에서는 ES5 JavaScript에 대해 중급 이상이라고 가정합니다. 예를 들어 목록을 필터링하는 computed 속성에서 Array.prototype.filter가 ​​작동하는 방식을 설명하지 않습니다. 그러나 쿡북에는 더 나은 Vue 애플리케이션을 빌드하는데 도움이되는 맥락에서 필수 JavaScript 기능 (ES6/2015+ 포함)을 탐색하고 설명 할 수 있습니다.

  • 생태계 탐색(Exploring the Ecosystem) : 고급 기능의 경우에는 일부 생태계 지식을 알고 있다고 가정합니다. 예를 들어 Webpack에서 단일 파일 구성 요소를 사용하려는 경우 Webpack 구성의 Vue가 아닌 부분을 구성하는 방법에 대해서는 설명하지 않습니다. 쿡북에는 이러한 생태계 라이브러리를 보다 심도있게 탐색 할 수있는 공간이 있습니다. 적어도 Vue 개발자에게 보편적으로 유용한 범위입니다.

TIP

이러한 모든 차이점이 있지만 쿡북(cookbook)은 여전히 ​​단계별 설명서가 아닌 것을 명심하세요. 대부분의 콘텐츠에서 HTML, CSS, JavaScript, npm/yarn 등과 같은 개념에 대한 기본적인 이해가 필요합니다.

# 쿡북 기여

# 우리가 찾고 있는 것

쿡북은 개발자에게 공통적이거나 흥미로운 사용 사례를 모두 다루고 더 복잡한 세부 사항을 점진적으로 설명하는 예제를 제공합니다. 우리의 목표는 간단한 소개 예제를 넘어서 더 광범위하게 적용할 수 있는 개념과 접근 방식에 대한 몇 가지 주의사항을 보여주는 것입니다.

기여에 관심이 있는 경우 성공적인 pull request로 안내할 수 있도록 개념과 함께 쿡북 아이디어 태그 아래에 문제를 제출하여 협업을 시작하세요. 아이디어가 승인된 후 가능한 한 아래 템플릿을 따르십시오. 일부 섹션은 필수이고 일부는 선택사항입니다. 숫자 순서를 따르는 것이 강력하게 제안되지만 필수는 아닙니다.

일반적으로 레시피는 다음과 같아야합니다:

  • 구체적이고 일반적인 문제 해결
  • 가능한 가장 간단한 예제로 시작
  • 복잡성을 한번에 하나씩 소개
  • 개념을 다시 설명하는 대신, 다른 문서에 연결
  • 익숙하다고 가정하지 말고 문제를 설명
  • 최종 결과가 아닌 프로세스를 설명
  • 적절한 또는 적절하지 않은 시기를 포함하여, 전략의 장단점을 설명
  • 관련이 있는 경우 대체 솔루션을 언급하되 별도의 레시피에 대한 심층 탐색을 남김

아래 템플릿을 따르시기 바랍니다. 그러나 명확성과 흐름을 위해 반드시 따르지 않는 경우가 있음을 이해합니다. 어느 방식이든, 모든 레시피는 어느 시점에서 이 패턴을 사용하여 선택한 뉘앙스를 논의해야하며, 가급적이면 대체 패턴 섹션의 형태로 이루어져야 합니다.

# 기본 예제 required

  1. 문제를 한두 문장으로 표현하십시오.
  2. 한두 문장으로 가능한 가장 간단한 해결책을 설명하십시오.
  3. 작은 코드 샘플을 보여줍니다.
  4. 이것이 무엇을 해내는지 한 문장으로 설명하십시오.

# 값에 대한 세부정보 required

  1. 예제를 보면서 가잘 수 있는 일반적인 질문에 대해 설명합니다. (블록따옴표는 이것에 좋습니다)
  2. 일반적인 실수의 예제와 이를 방지할 수 있는 방법을 보여줍니다.
  3. 좋고 나쁜 패턴의 매우 간단한 코드 샘플을 보여줍니다.
  4. 이것이 왜 설득력있는 패턴인지 토론하십시오. 참조 링크는 필수는 아니지만 권장입니다.

# 실제 사례 required

다음과 같은 방법으로 일반적이거나 흥미로운 사용 사례를 강화하는 코드를 보여줍니다:

  1. 몇 가지 간단한 설정 예를 살펴보거나,
  2. codepen/jsfiddle 예제를 포함합니다.

후자를 선택하는 경우에도, 당신은 여전히 그것이 무엇인지 그리고 무엇을 하는지를 이야기해야합니다.

# 추가 컨텍스트 optional

이 패턴에 대한 약간의 글을 쓰는 것은 매우 도움이 됩니다. 다른 곳에 적용할 수 있고, 왜 잘 작동되는지, 그렇게하면서 약간의 코드를 실행하거나 여기에서 사람들에게 더 많은 자료를 제공하는 것이 좋습니다.

# 이 패턴을 피해야하는 경우 optional

이 섹션은 필수는 아니지만 적극 권장합니다. 상태 변경을 기반으로 클래스를 토글하는 것과 같이 매우 간단한 것으로 작성하는 것은 이치에 맞지 않지만, mixin과 같은 고급 패턴의 경우 중요합니다. 개발에 대한 대부분의 질문에 대한 대답은 "상황에 따라 다릅니다!" (opens new window)이며 이러한 패턴은 피해야합니다. 여기서 우리는 패턴이 유용할 때와 피해야할 때 또는 다른 패턴이 더 합리적일 때 정직하게 살펴볼 것입니다.

# 대체 패턴 required with avoidance section

이 섹션은 위에서 언급한 회피에 대한 섹션을 제공할 때 필요합니다. 특정 상황에서 무언가 안티패턴이라고 사람들이 궁금해하지 않도록 다른 방법을 탐색하는 것이 중요합니다. 그렇게할 때, 웹은 큰 텐트(big tent, 다양한 그룹이나 아이디어를 포함하는 그룹)이며, 많은 사람들이 서로 다른 코드베이스 구조를 가지고 있으며, 서로 다른 목표를 해결하고 있다는 것을 고려하십시오. 앱이 크거나 작습니까? Vue를 기존 프로젝트에 통합하고 있습니까? 아니면 처음부터 구축하고 있습니까? 사용자가 하나의 목표만 달성하려고 합니까? 비동기 데이터가 많습니까? 이러한 모든 고려사항은 대체 구현(alternative implementations)에 영향을 미칩니다. 좋은 쿡북 레시피는 개발자에게 이러한 맥락을 제공합니다.

# 감사합니다

문서화에 기여하는 데는 시간이 걸리며, 우리 문서의 이 섹션에 PR을 제출하는데 시간을 할애한다면 감사합니다.

Deployed on Netlify.
Last updated: 1/13/2021, 5:23:36 AM