인프런 커뮤니티 질문&답변
작성한 질문수
포트폴리오(프로젝트)가 완성되면 문서정리..
작성
·
155
·
수정됨
0
곧 프로젝트가 다 완성되가는데, 보통 프로젝트 완성되면 erd, 사용자 기능 요구사항 명세서 , API 명세서 등 정리해서 문서로 만들더라구요, 어떤것들이 문서로 정리해서 들어가는게 정석일까요? 어떻게 문서로 정리해야할지 감이 안와용
답변 1
0
안녕하세요, 인프런 AI 인턴입니다.
ajn님, 프로젝트 완성 후 문서 정리는 프로젝트의 효율적 관리와 향후 유지보수에 매우 중요합니다. 일반적으로 다음과 같은 문서들이 정리되는 것이 좋습니다:
- ERD(엔터티 관계 다이어그램): 데이터베이스 구조를 시각적으로 표현합니다. 테이블간의 관계를 명확히 하여 데이터 모델을 이해하는 데 도움을 줍니다.
- 사용자 기능 요구사항 명세서: 프로젝트가 해결하고자 하는 문제와 사용자가 프로젝트를 사용하며 달성하길 원하는 목표를 상세히 기술합니다. 기능별 요구사항을 명확하게 정리해야 합니다.
- API 명세서: 시스템이 제공하는 모든 API의 명세를 기술합니다. 각 API의 엔드포인트, 메소드, 요청 파라미터, 응답 바디 등을 포함합니다.
- 프로젝트 설계 문서: 시스템의 전반적인 아키텍처와 각 컴포넌트의 상세 설계를 기술합니다. 클래스 다이어그램이나 시퀀스 다이어그램도 포함할 수 있습니다.
- 개발환경 설정 문서: 프로젝트를 설정하고 실행하는 방법을 상세히 기술합니다. 필요한 소프트웨어, 라이브러리 버전 및 설정 방법 등을 포함합니다.
- 테스트 사례 및 결과 문서: 프로젝트의 각 기능에 대한 테스트 케이스와 실행 결과를 명세합니다. 버그 리포트도 포함할 수 있습니다.
문서화는 프로젝트의 성공을 위한 핵심 요소 중 하나이며, 논리적인 구조와 함께 명확하고 간결한 언어로 작성하는 것이 중요합니다. 기존의 프로젝트 문서화 사례를 참조하거나 관련 도구(예: Swagger for API documentation)를 사용하여 효율적으로 문서화 할 수 있습니다.