개발문서작성하시는 예제가있을까요?

토이프로젝트나 실무에서 진행하는 프로젝트에서 개발 문서를 작성하는 예제가 있을까요?

프로젝트를 시작하기전에 생각해둔 프로젝트의 설명등을 개발문서를 통해 미리 작성해두면 프로젝트를 진행할 때 도움이된다고해서 원페이저 양식을 사용해 작성해보려고합니다.

그런데 각항목들에 들어갈 내용들을 어떤걸로 채워야될지 모르겠습니다…
구글링을 해봤는데 양식에 대한 설명같은것들은 많지만 실제로 작성된 개발문서는 안보이더군요…

혹시 선배님들이 개발문서를 작성할때 참고하신 예제문서같은게 있을까요?


제가 사용한 원페이저양식입니다.

  • 타이틀
    작성가능

  • 프로젝트 설명
    작성 가능

  • 산출물
    웹프로젝트의 경우 "~ 한 서비스를 지원하는 사이트입니다."라고 작성하면 되는지 궁금합니다.

  • 비즈니스, 마케팅 타당성
    프로젝트를 진행하려는 목적을 작성하면되는지 궁금합니다.

  • 리스크 평가
    아직 시작도 하지않은 구상중인 프로젝트에서 어떤 리스크가 예상되는지를 어떻게 적어야될지 모르겠습니다.

  • 일정/참여 인력
    작성가능

  • 기술 설명
    ~기능을 개발할 것이다. 라고 작성하면되는지 궁금합니다.

4개의 좋아요

(답변에 혹시 잘못된 부분이 있거나 보충이 필요하시면 피드백 부탁드립니다. :bowing_man:)

보여주신 양식은 탑다운 진행 방식에서 주로 사용하는 내용들인것 같습니다. 처음부터 큰 목표가 하달되는 경우에 많이 보이는 접근법인것 같아요.

요즈음은 이런 계획서보다는 개발 단계에서 큰 단위의 에픽을 설정한 후, 이것을 몇 주, 몇회동안 반복해서 완성해나갈것인지를 구상하는 방식을 더 많이 사용합니다.

그래서 구체적인 리스크 산정보다는, 최소한의 목표를 정해서 리스크를 최소화하기 위한 기획을 많이 고려하는것 같고요.

특히 토이프로젝트라면 이런 문서 작성이 형식적인 것에 불과할 가능성이 높아보입니다. 문서의 형식보다는, 토이 프로젝트가 지향하는 목표, 하고싶은 일, MVP (Most Viable Product) 구상 등을 고민해보시면 어떨지 제안드려봅니다. 그런 목표가 먼저 나온 후에는 반대로 이 문서를 쓰시는게 한결 간편해질것 같네요.

7개의 좋아요