멘토링과 기술 문서화
페어 프로그래밍과 적절한 시기의 피드백으로 주니어 팀원의 성장을 돕고, 아키텍처 결정을 ADR로 기록하며, 다른 사람이 신뢰할 수 있는 살아 있는 문서를 관리합니다.
멘토링과 기술 문서화은(는) CoddyKit의 무료 Frontend Academy 강의입니다. 이것은 4개 중 3번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 Frontend Academy 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. Frontend Academy 강의에는 총 4개의 강의가 포함되어 있습니다.
선임 개발자는 다른 사람을 성장시킵니다
선임 개발자의 일은 가장 많은 코드를 작성하는 것이 아니라 팀을 더 나은 팀으로 만드는 것입니다. 주니어 개발자를 멘토링하고, 지식을 확장할 수 있는 문서를 작성하며, 가르침을 주는 코드 리뷰를 하고, 다른 사람들이 안전하게 빠르게 움직일 수 있도록 아키텍처를 설계합니다.
페어 프로그래밍으로 멘토링하기
페어 프로그래밍은 주니어 개발자를 성장시키는 가장 빠른 방법입니다. 함께 앉거나 화면을 공유하고, 본인이 방향을 제시하는 동안 주니어 개발자가 직접 조작하게 합니다. 대신 작성해 주고 싶은 마음을 참으십시오. 자신의 생각을 설명하고 소크라테스식 질문을 하십시오.
적절한 수준의 도전 과제
주니어 개발자에게 현재 능력보다 약간 어려운 과제를 주십시오. 너무 쉬우면 성장하지 못하고, 너무 어려우면 감당하지 못해 좌절합니다. 다음과 같이 조정하십시오. '조금만 도와주면 해낼 수 있을 것 같습니다. 막히면 기꺼이 함께 작업하겠습니다.'
가르침으로서의 코드 리뷰
주니어 개발자의 PR에서는 사소하지 않은 모든 의견에 그 이유를 설명합니다. 관련 문서, 이전 PR 또는 글을 연결합니다. 좋지 않은 리뷰는 'useCallback을 사용하세요'입니다. 좋은 리뷰는 '이 함수는 렌더링될 때마다 다시 만들어집니다. 메모이제이션된 자식에게 전달하면 불필요한 재렌더링이 발생합니다. useCallback은 이 함수를 메모이제이션합니다. 우리가 이렇게 처리한 예시 PR은 여기 있습니다: #1234'입니다.
아키텍처 결정 기록(ADR)
ADR은 중요한 아키텍처 선택을 기록합니다. 무엇을 결정했는지, 왜 결정했는지, 어떤 대안을 검토했는지, 어떤 절충을 받아들였는지를 남깁니다. 미래의 여러분은 현재의 여러분에게 감사하게 될 것입니다.
# ADR-0007: Use TanStack Query for server state
Date: 2026-05-01
Status: Accepted
## Context
We currently scatter useEffect+fetch+useState patterns across the app.
Cache invalidation is inconsistent, race conditions cause stale data.
## Decision
Adopt TanStack Query (@tanstack/react-query v5) for all server state.
## Consequences
+ Built-in caching, deduplication, optimistic updates.
+ Standard pattern across team.
- Adds ~13KB gzipped.
- Team needs to learn query keys conventions.
## Alternatives Considered
- SWR: smaller, but fewer features (no mutations).
- Apollo Client: overkill (we don't use GraphQL).
- Custom hook: doesn't solve cache invalidation.
## References
- React Query docs: ...ADR은 어디에 보관할까요
ADR은 저장소의 docs/adr/에 순서대로 번호를 매겨 보관합니다. ADR은 설명하는 코드와 함께 관리됩니다. 도구로는 웹 사용자 인터페이스에서 탐색할 수 있는 adr-tools와 log4brains가 있습니다.
README 품질
모든 패키지와 라이브러리, 주요 기능에는 README가 필요합니다. 다음을 포함합니다. 무엇을 하는지, 설치 방법, 사용 방법(코드 예시 포함), 기여 방법, 테스트 실행 방법, 디버깅 방법. README 중심 개발에서는 먼저 README를 작성한 다음 그 명세에 맞춰 개발합니다.
인라인 코드 주석 — 언제 사용할까요
주석은 무엇을 하는지가 아니라 왜 하는지를 설명해야 합니다. 무엇을 하는지는 코드가 보여 줍니다. 주석으로는 비즈니스 규칙, 바로 드러나지 않는 절충, 티켓이나 오류로 연결되는 링크, 주의해야 할 함정에 대한 경고를 설명합니다.
// BAD: comment restates the code
// Increment counter by 1
counter++;
// GOOD: comment explains business context
// Stripe webhook can arrive twice — increment only if signature is fresh.
// See: https://stripe.com/docs/webhooks/best-practices#idempotency
if (!seen.has(event.id)) counter++;운영 작업을 위한 런북
반복되거나 위험한 운영 작업을 수행하는 방법을 문서화합니다. 예를 들면 'Stripe 애플리케이션 프로그래밍 인터페이스 키를 교체하는 방법', '배포 실패에서 복구하는 방법', '느린 애플리케이션 프로그래밍 인터페이스 응답을 디버깅하는 방법'이 있습니다. 새 팀원도 여러분을 호출하지 않고 따라 할 수 있습니다.
계속 갱신되는 문서
오래된 문서는 문서가 없는 것보다 나쁩니다. 작성 날짜를 기록합니다. 분기마다 검토합니다. 아무도 업데이트하지 않는 문서는 삭제합니다. 더 좋은 방법은 코드에서 문서를 생성하는 것입니다. 컴포넌트에는 Storybook을, 애플리케이션 프로그래밍 인터페이스에는 TypeDoc을, 엔드포인트에는 OpenAPI를 사용할 수 있습니다.
기술 발표와 브라운백 세션
새 라이브러리, 디버깅 경험, 유용하다고 생각한 패턴 등 자신이 배운 내용을 팀에 20~30분 동안 발표합니다. 생각을 정리하게 만들고 다른 사람을 가르칠 수 있습니다.
심리적 안전감 만들기
질문하기를 두려워하는 주니어 개발자는 성장하지 못합니다. '모르겠습니다'라고 말하는 것을 자연스럽게 만드십시오. 실수해도 안전한 환경을 만드십시오. 비난이 아니라 사후 분석을 긍정적으로 받아들이십시오. 선임 개발자인 여러분의 반응이 팀의 분위기를 결정합니다.
영웅적 코딩의 함정
모든 운영 장애를 혼자 해결하는 사람이 되지 마십시오. 해결 방법을 문서화하고, 다음에는 팀원과 함께 작업하며, 진단을 자동화합니다. 여러분의 영웅적 행동이 필요한 팀은 취약합니다.
빠른 확인
아키텍처 결정 기록(ADR)의 주된 목적은 무엇인가요?
복습: 멘토링과 문서
선임 개발자는 가장 많은 코드를 작성하는 사람이 아니라 다른 사람을 성장시키는 사람입니다. 페어 프로그래밍을 하고, 코드 리뷰로 가르치며, 적절한 수준의 도전 과제를 제공합니다. docs/adr/의 ADR은 결정이 내려진 이유를 기록합니다. 모든 패키지에는 README를 작성합니다. 주석은 무엇이 아니라 왜를 설명합니다. 운영 작업에는 런북을 사용합니다. 계속 갱신되는 문서(Storybook, TypeDoc, OpenAPI)가 정적인 마크다운보다 낫습니다. 심리적 안전감을 만듭니다. 영웅적 코딩은 피합니다.
자주 묻는 질문
“멘토링과 기술 문서화” 강의는 무료인가요?
네 — “멘토링과 기술 문서화” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 Frontend Academy 강의 전체를 잠금 해제할 수 있습니다. Frontend Academy 강의에는 총 4개의 강의가 포함되어 있습니다.
“멘토링과 기술 문서화”에서 뭘 배우나요?
페어 프로그래밍과 적절한 시기의 피드백으로 주니어 팀원의 성장을 돕고, 아키텍처 결정을 ADR로 기록하며, 다른 사람이 신뢰할 수 있는 살아 있는 문서를 관리합니다. 브라우저에서 직접 실행하는 실습 코드로 Frontend Academy을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.
Frontend Academy을(를) 시작하는 데 경험이 필요한가요?
사전 경험은 필요하지 않습니다. CoddyKit의 Frontend Academy은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 4개 중 3번째 강의입니다.
“멘토링과 기술 문서화” 강의는 얼마나 걸리나요?
대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.
이 Frontend Academy 강의에서 코드를 작성하고 실행할 수 있나요?
네. 모든 Frontend Academy 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.