<aside> 💡

목차

</aside>

우리는 프로젝트 진행 과정에서 생성되는 기술 문서를 일관성 있게 작성하고, 협업 효율을 높이기 위한 내부 규칙을 정의하고 지킨다.

1️⃣ 문서 작성 원칙

1. "결과"가 아닌 "의사결정 기록"이다

• 기술 문서는 단순한 구현 설명이 아니라, 왜 이런 선택을 했는지를 기록하는 문서이다.
• 코드로 표현되지 않는 배경, 제약, 트레이드오프를 반드시 포함한다.

2. 다른 팀원도 단독으로 이해 가능해야 한다

• 작성자를 제외한 팀원이 문서만 보고도 다음 질문에 답할 수 있어야 한다.
  • 이 기능은 왜 필요한가?
  • 어떤 문제를 해결하려는가?
  • 왜 이 방식이 선택되었는가?

3. 하나의 문서에는 하나의 책임만 가진다

• 한 문서는 하나의 기능, 하나의 기술적 결정만을 다룬다.
• 여러 기능이나 주제를 혼합하지 않는다.

4. 추상적인 표현을 지양한다

• ❌ "성능이 좋아서 선택"
• ✅ "현재 트래픽 규모와 단일 서버 환경을 고려할 때 복잡도를 최소화하기 위함"

5. 미래 변경 가능성을 명시한다

• 현재 결정이 최종이 아닐 수 있음을 전제로 한다.
• 추후 확장 또는 변경이 가능한 지점을 문서에 남긴다.