{{{#!html
<div class="shine-editor"><h2><br></h2><h1>1️⃣ 프로젝트 개요 문서 (Overview)</h1><h3>목적</h3><ul><li>
<div>이 프로젝트가 <b>무엇을 해결하는지</b></div>
</li><li>
<div>어디에 쓰이고</div>
</li><li>
<div>어떤 제약이 있는지</div>
</li></ul><h3>포함 내용</h3><ul><li>
<div>프로젝트 목적 / 비즈니스 배경</div>
</li><li>
<div>주요 기능 요약</div>
</li><li>
<div>현재 버전 및 릴리즈 이력</div>
</li><li>
<div>전체 아키텍처 다이어그램</div>
</li><li>
<div>외부 의존성 (라이브러리, SDK, OS 등)</div>
</li><li>
<div>지원 플랫폼 (Windows/Linux/macOS 등)</div>
</li><li>
<div>주요 제약 사항 (성능, ABI, 메모리, 실시간성 등)</div>
</li></ul><blockquote>
<div>이 문서는 “전체 그림을 이해”시키는 역할입니다.</div><div>
</div></blockquote><div>
<hr>
</div><h1>2️⃣ 빌드 &amp; 개발 환경 문서</h1><h3>목적</h3><ul><li>
<div><b>새로운 사람이 당일에 빌드 성공</b>하게 하는 것</div>
</li></ul><h3>포함 내용</h3><ul><li>
<div>필수 개발 환경</div>
</li><ul><li>
<div>컴파일러 (MSVC 19.xx, GCC xx, Clang xx)</div>
</li><li>
<div>C++ 표준 (C++17? 20?)</div>
</li></ul><li>
<div>필수 패키지 / 외부 라이브러리 버전</div>
</li><li>
<div>CMake 옵션 / 빌드 스크립트 설명</div>
</li><li>
<div>Debug/Release 차이</div>
</li><li>
<div>ABI 옵션 (wchar_t, STL, 런타임 등)</div>
</li><li>
<div>빌드 시 자주 발생하는 문제와 해결법</div>
</li><li>
<div>CI/CD 구조 설명</div>
</li></ul><blockquote>
<div>이 문서가 없으면 인수인계는 실패합니다.</div><div>
</div></blockquote><div>
<hr>
</div><h1>3️⃣ 디렉터리 구조 설명서</h1><h3>목적</h3><ul><li>
<div>폴더 구조의 의도 설명</div>
</li></ul><div>예:</div><pre spellcheck="false">/core          → 핵심 엔진
/ui            → UI 레이어
/platform      → OS별 구현
/instrument    → 내부 디버깅/로깅
/tests         → 테스트 코드
</pre><div>각 디렉터리의 역할을 간결히 설명합니다.</div><div>
<hr>
</div><h1>4️⃣ 아키텍처 설계 문서 (중요)</h1><h3>포함 내용</h3><ul><li>
<div>전체 레이어 구조</div>
</li><li>
<div>주요 클래스 관계도 (UML 권장)</div>
</li><li>
<div>핵심 설계 패턴</div>
</li><ul><li>
<div>Observer</div>
</li><li>
<div>Command</div>
</li><li>
<div>Factory</div>
</li><li>
<div>PImpl</div>
</li></ul><li>
<div>객체 생명주기</div>
</li><li>
<div>메모리 소유권 구조</div>
</li><li>
<div>스레딩 모델</div>
</li><li>
<div>이벤트 흐름</div>
</li></ul><blockquote>
<div>특히 C++은 <b>소유권과 lifetime</b> 설명이 없으면 유지보수자가 고통받습니다.</div><div>
</div></blockquote><div>
<hr>
</div><h1>5️⃣ 핵심 모듈 상세 설명</h1><div>모든 파일 설명은 필요 없습니다.<br>
대신 아래를 설명하세요:</div><ul><li>
<div>시스템의 중심 클래스</div>
</li><li>
<div>변경 위험이 큰 부분</div>
</li><li>
<div>이해하기 어려운 알고리즘</div>
</li><li>
<div>역사적 이유로 남아있는 코드</div>
</li></ul><div>예:</div><ul><li>
<div>MatrixTransform.cpp의 역할</div>
</li><li>
<div>Editor Read-only 모드 구조</div>
</li><li>
<div>UTF 변환 처리 구조</div>
</li><li>
<div>플랫폼별 분기 로직</div>
</li></ul><div><hr>
</div><h1>6️⃣ API / 인터페이스 문서</h1><div>외부에서 사용하는 API가 있다면:</div><ul><li>
<div>공개 헤더 설명</div>
</li><li>
<div>파라미터 의미</div>
</li><li>
<div>예외 처리 정책</div>
</li><li>
<div>Thread-safe 여부</div>
</li><li>
<div>ABI 주의사항</div>
</li></ul><div>가능하면 Doxygen 스타일로 자동 생성 가능하게.</div><div>
<hr>
</div><h1>7️⃣ 테스트 전략 문서</h1><ul><li>
<div>유닛 테스트 범위</div>
</li><li>
<div>통합 테스트 방법</div>
</li><li>
<div>수동 테스트 시나리오</div>
</li><li>
<div>성능 테스트 방법</div>
</li><li>
<div>재현 방법이 필요한 주요 버그 목록</div>
</li></ul><div><hr>
</div><h1>8️⃣ 운영/배포 문서</h1><ul><li>
<div>배포 프로세스</div>
</li><li>
<div>버전 관리 전략</div>
</li><li>
<div>브랜치 전략 (Git flow 등)</div>
</li><li>
<div>릴리즈 체크리스트</div>
</li><li>
<div>핫픽스 절차</div>
</li></ul><div><hr>
</div><h1>9️⃣ 리스크 &amp; 기술 부채 문서 (매우 중요)</h1><div>이게 인수인계에서 가장 가치 있습니다.</div><ul><li>
<div>리팩토링 필요 영역</div>
</li><li>
<div>위험한 코드</div>
</li><li>
<div>구조적 한계</div>
</li><li>
<div>언젠가 폭발할 수 있는 부분</div>
</li><li>
<div>제거 예정 레거시</div>
</li></ul><div>이 문서가 없으면 다음 사람이 지뢰를 밟습니다.</div><div>
<hr>
</div><h1>🔟 FAQ / 트러블슈팅</h1><ul><li>
<div>빌드 실패 원인 Top 5</div>
</li><li>
<div>특정 환경에서만 깨지는 문제</div>
</li><li>
<div>플랫폼별 주의점</div>
</li><li>
<div>자주 하는 질문</div>
</li></ul><div><hr>
</div><h1>🔥 최소 세트 (시간 없을 때)</h1><div>시간이 부족하다면 반드시 작성해야 할 5개:</div><ol><li>
<div>프로젝트 개요</div>
</li><li>
<div>빌드 가이드</div>
</li><li>
<div>아키텍처 설명</div>
</li><li>
<div>핵심 모듈 설명</div>
</li><li>
<div>기술 부채 목록</div>
</li></ol><div><hr>
</div><h1>📌 잘 작성하는 팁</h1><ul><li>
<div>“왜 이렇게 설계했는가”를 반드시 적기</div>
</li><li>
<div>코드 복붙하지 말 것</div>
</li><li>
<div>다이어그램 적극 활용</div>
</li><li>
<div>새로운 사람이 3일 안에 이해 가능해야 함</div>
</li><li>
<div>PDF 한 파일보다 Wiki 구조가 좋음</div></li></ul><div><br></div></div>
}}}
----
CategoryDocument