개발자
안녕하세요. 이번에 처음으로 팀프로젝트를 진행하게 되었습니다. 아직 구상단계이지만 설계를 진행하기전 몇가지 궁금한 내용이 있어 문의드립니다. 1. 각 단계별로 문서화를 어떻게 진행하는지 궁금합니다. 2. 하나의 개발 방법론으로 서비스 종료까지 진행하는지 궁금합니다. 2-1. 요구사항 정의 후 각 마일스톤별로 개발 방법론을 결정하는지 궁금합니다. 3. 모듈 내 함수나 클래스에 모두 Doc으로 주석을 작성하는지 궁금합니다. 4. 이전에 근무시 문서가 PDD, TDD, FDD로 나뉘었는데문서화를 어떤 시점에 해야하는지 궁금합니다. 처음으로 공학이론을 접목시켜 진행하려다보니 질문이 길어졌습니다. 바쁘신 와중에 긴 글 읽어주셔서 감사합니다.
답변 2
1. 요구사항 명세 - 서비스 기획서 - 정보구조도 및 화면설계서 - 디자인 가이드 - 개발 스타일 문서 - 소스코드 문서 - 테스트 리포트 - 운영 가이드 * 각 항목은 여러가지 세부항목을 가지고 있으며 프로젝트 목적에 따라 규모와 디테일이 달라집니다. 위 항목은 일반적인 개발 흐름에서 나오는 문서 목록을 나열한 것 입니다. 구체적인 작성은 엑셀을 쓸 수도 있고 피그마 같은 툴을 쓸 수도 있습니다. 2. 합의하에 실제 수행 가능하며 관리할 수 있는 경우, 그 방법론을 따릅니다. 팀, 회사, 문화마다 차이가 있으니 선택은 자유입니다. 2-1. 마일스톤을 목표의 세부 목표쯤으로 정의한다면 개발 방법론에 영향을 주지 않는 것 같습니다. 프로덕트의 생명주기에 따르거나 또는 얼마나 자주 변형 또는 확장될 것인지에 따라서 개발 방법론을 고르는 것이 현명하다고 생각합니다. 3. 세세하게 적으려 들면 끝이 없습니다. 에초에 함수명과 클래스 명의 의미를 추론하거나 따로 찾아볼 필요 없이 명시적으로 적는 것이 더 효율적입니다. 작성 뒤 이름을 읽었을 때, 처음 읽는 사람 기준으로 맥락이 필요하거나 추가적인 정보가 필요한 사항만 작성하시는 것을 권장합니다. 4. 한 작업 단위가 끝나고 틈틈히 하시는걸 권장합니다. 한 번에 쓰려면 너무 방대한 작업이 될 수 있습니다.
박장환
작성자
QA Engineer • 2023년 04월 27일
좋은 말씀 감사합니다. 참조하여 좋은 작품 만들어보겠습니다 :)
안녕하세요. 팀프로젝트 진행에 대한 궁금한 점에 대해 답변드리겠습니다. 1. 각 단계별로 문서화를 어떻게 진행하는지 궁금합니다. > 각 단계별로 필요한 문서들은 다르겠지만, 대체로 요구사항 정의서, 설계서, 개발 가이드 문서 등을 작성합니다. 이들 문서는 프로젝트 전체에서 필요한 내용을 작성하고, 문서화된 내용을 기반으로 개발을 진행합니다. 2. 하나의 개발 방법론으로 서비스 종료까지 진행하는지 궁금합니다. > 하나의 개발 방법론을 선택해 프로젝트를 진행하는 경우가 있지만, 대체로 다양한 방법론을 혼합하여 사용하는 경우가 많습니다. 예를 들어, Agile 방법론을 사용하되, 일부 프로젝트 단계에서는 Waterfall 방법론을 활용하는 경우도 있습니다. 2-1. 요구사항 정의 후 각 마일스톤별로 개발 방법론을 결정하는지 궁금합니다. > 일반적으로 요구사항 정의 이후, 전체 프로젝트의 방향성과 범위를 정하고 개발 방법론을 결정합니다. 그러나 개발 방법론은 프로젝트가 진행되면서 변경될 수 있습니다. 예를 들어, Agile 방법론을 사용하던 프로젝트에서 중간에 Waterfall 방법론을 적용하는 경우가 있습니다. 3. 모듈 내 함수나 클래스에 모두 Doc으로 주석을 작성하는지 궁금합니다. > 대체로 모듈, 함수, 클래스에 대해 문서화를 진행합니다. 주석으로 작성하는 경우도 많습니다. 이를 위해 JSDoc 같은 도구를 사용하여 자동 문서화도 가능합니다. 4. 이전에 근무시 문서가 PDD, TDD, FDD로 나뉘었는데문서화를 어떤 시점에 해야하는지 궁금합니다. >문서화는 프로젝트 초기 단계부터 진행되어야 합니다. 특히, PDD(프로젝트 정의서)는 프로젝트가 시작되기 전에 작성되어야 하며, TDD(테스트 설계서), FDD(기능 설계서) 등은 개발 전 단계에서 작성되어야 합니다. 문서화가 미흡하게 이루어지면 개발에 큰 지장을 줄 수 있기 때문입니다.
커리어리 AI 봇의 답변을 평가해 주세요!
지금 가입하면 모든 질문의 답변을 볼 수 있어요!
현직자들의 명쾌한 답변을 얻을 수 있어요.
이미 회원이신가요?
지금 가입하면 모든 질문의 답변을 볼 수 있어요!