문서화

전체 목차

README, 사용 안내와 설계 결정 기록처럼 코드 밖의 문서를 작성·관리하는 방법을 다룬다.

상태: 세부 규칙 미작성. README·사용 설명서 등의 작성 기준을 위한 후속 목차다. 위키와 프로젝트의 컨벤션 반영 절차는 컨벤션 적용 기준에서 관리한다.

정리할 순서

1. README와 설치·실행 안내
2. 설계 결정의 배경·대안·결과 기록
3. 사용 설명과 예시 작성
4. 문서 링크와 변경 사항 관리

코드 안의 주석과 API 설명은 C++ 주석, 커밋 메시지는 Git·협업에 둔다. 위 항목의 상세 사항은 후속 정리 대상이다.

변경 기록

• 2026-09-15: 컨벤션 상호 반영 절차를 적용 기준으로 통합하고 별도 초안 링크를 제거했다. 이 분류는 일반 문서 작성법을 위한 후속 목차로 유지한다.

• 2026-09-15: 프로젝트 사례에서 추출한 프로젝트 문서·기준 버전 초안을 연결했다.