README Driven Development (2010)

(tom.preston-werner.com)

43P by xguru 10일전 | favorite | 댓글 9개

README 주도 개발 : 소프트웨어 개발시 README를 먼저 작성하는 접근 방식
TDD, BDD, Extreme Programming, SCRUM 등의 다양한 개발 방법론과 기술에 대해 많이 듣게 됨
- 하지만, 우리가 개발하는 소프트웨어가 사용자의 필요를 충족시키지 못하면 모든 것이 무의미함
- 완벽한 구현이라도 잘못된 명세를 따르면 무가치하며, 문서화되지 않은 아름다운 라이브러리도 거의 무가치함
- 소프트웨어가 잘못된 문제를 해결하거나 사용법을 알 수 없으면 심각한 문제 발생

해결책: README 부터 작성하기

Readme를 먼저 작성해야 하는 이유
- 코드, 테스트, 스토리 등을 작성하기 전에 먼저 Readme부터 작성
- Readme 작성은 좋은 소프트웨어를 만들기 위한 필수 단계
- 소프트웨어에 대해 글로 작성하기 전까지는 무엇을 코딩할지 명확하지 않음
- Readme를 통해 프로젝트를 체계적으로 생각할 수 있음
README 우선 작성의 이점:
- 프로젝트를 체계적으로 생각할 기회:
  - 코드를 변경할 필요 없이 프로젝트를 체계적으로 생각할 수 있음
  - 코딩 전 프로젝트의 구조와 포함될 API를 고민할 수 있음
- 우수한 문서 확보:
  - 프로젝트 초기에 높은 동기부여와 흥미를 가진 상태에서 문서를 작성할 수 있음
  - 나중에 Readme를 작성하는 것은 지루하고 중요한 세부 사항을 놓칠 수 있음
- 팀 작업의 효율성 증가:
  - 팀의 다른 개발자들이 프로젝트 완성 전에 인터페이스에 대한 정보를 공유받아 다른 작업을 자신있게 시작할 수 있음
  - 명확한 인터페이스 없이 작업하면 대규모 코드 재작업이 필요할 수 있음
- 구체적인 토론 기반 제공:
  - 텍스트로 제안된 해결책을 작성하는 간단한 행위로 모두가 명확한 아이디어를 가지고 논의할 수 있음
README 주도 개발(RDD)의 특징:
- RDD는 Documentation Driven Development(DDD)의 하위 집합이나 제한된 버전으로 볼 수 있음
- RDD는 단일 파일로 설계 문서를 제한하여 과도한 사양 작성의 문제를 방지함
- 작은 모듈화된 라이브러리를 유지하도록 유도함