소프트웨어 문서란?

요구사항 명세서

이름	영문	설명
요구사항 명세서	Standard Requirements Standards	소프트웨어에 달성해야하는 사항을 상세히 명세한 문서

[필요한 조치]

• 관계자가 모두 관여해야함.
• 문서는 항상 최신상태로.
• 여러 비용이 현실적으로 고려되어야함.
• 비전공자도 이해할 수 있는 언어를 사용하고 부록을 포함해야함.

[담겨야할 정보 예시]

• 소프트웨어 개요 (소개, 목적, 주 고객층 제시)
• 유저 시나리오
  • 소프트웨어가 목표대로 작동하는 목표 시나리오
  • 실제 사용하면서 발생할 수 있는 경험 시나리오
• 와이어 프레임 (각 UI의 기능을 시각적으로 드러냄)
• 구동 환경: 해당 소프트웨어가 작동하기 위해 달성해야할 조건.
• 요구 성능: 해당 소프트웨어가 목표를 얼마나 원활히 수행하는가?
• 제한 사항: 이해관계자들이 납득할 수 있는 소프트웨어 사용의 제한사항.

---

소프트웨어 설계 사양서

이름	영문	설명
소프트웨어 설계 명세서	Software Design Standards	소프트웨어의 전반적인 설계를 상세히 명세한 문서

[필요한 조치]

• 핵심 기술진의 주도 하에 작성.
• SRS 기반으로 작성.
• 유지보수성을 주목할 것.
• 기술적으로 진짜 가능한 것을 남김.
• 개발자만 이해해도 상관없음.

[담겨야할 정보 예시]

• 와어이 프레임 (SRS 보다 상세해야함)
• 개발 환경: 소프트웨어를 개발할 환경. (프로그래밍 언어 등)
• 디자인 패턴: 어떤 구조로 구현할 것인가?
• 연계 기술: 이 소프트웨어와 연관된 기술.
• 구동 환경: 구동될 OS 등 환경.
• API 명세서: 사용되는 메소드&API 관련 정보를 도표화.
• UML: 통합 모델링 언어.
• ERD: 개체 관계 다이어그램. DB 내 각 개체들의 관계를 다이어그램화.
• 파일구조: 폴더랑 파일 위치, 각자의 기능 등을 나타냄.

---

소프트웨어 코드 사양서

이름	영문	설명
소프트웨어 코드 사양서	Software Code Standards	소프트웨어 개발에 쓸 코드에 대한 표준 문서

[필요한 조치]

• 유지보수와 인수인계, 국제 표준을 고려해 작성.
• 최대한 관료하나 명확하게.
• 최소한 하드웨어, QA 팀 등은 이해할 수 있어야함.

[담겨야할 정보 예시]

• 개발 환경, 사용할 언어
• 개발 방식
• 코드 컨벤션 (코드를 어떻게 작성할 지 규정한 규칙)
• 이슈 처리 방법 (문제 발생 시 대응하는 방법)
• 형상 관리 정보 (관리 주기, commit 컨벤션 등)

---

업무 분류 체계

이름	영문	설명
업무 분류 체계	Work Breakdown Structure	프로젝트 수행을 위해 업무를 분류한 문서

[필요한 조치]

• 일정을 넘어서지 않도록 계획.
• 적절한 기간 확보, 적절한 업무 분배를 고민해야함.

[담겨야할 정보 예시]

• 개발 일정
• 개발 항목 (업무 내용, 담당자)
• KPI: 핵심 성과 지표

---

검증과 확인

이름	영문	설명
검증 및 확인	Verification & Validation	소프트웨어 신뢰성과 성능을 보장하기 위해 진행할 시험 관련 정보

[담겨야할 정보 예시]

• 검증은 개발자 중심 (요구사항), 확인은 사용자 중심 (사용감)
• 시험 계획과 항목
• 사이버 보안 확인 목록
• 제한사항
• UX 관련 피드백 보고서

---

기타 정보

추가 문서

• 사용자 설명서
• 관리자 안내서
• 라이선스 관련 문서 등...

버전 명칭

• 메이저 버전
• 마이너 버전
• 패치 버전

SA 문서 작성해보기

[링크]