SDS (Software Design Specification) 문서에 포함 할 내용

Question

저는 레일 개발자 인 루비입니다. 내 프로젝트의 경우 API 호출을 작성합니다. Angularjs는이 API를 사용하여 웹 페이지에 데이터를 표시합니다.

내가 코딩 좋은 생각 만이 내 SDS 문서에 lnclude 무엇을 잘 모릅니다 .. 내가 SDS의 문서를 만드는 것 처음입니다 ...

나는 SDS에 대한 인터넷 검색을하고 그것에 많은 기사를 발견했지만 그들 중 많은 사람들이 매우 높은 수준의 문서를 이해하기 어려웠습니다.

내 SDS 문서에 무엇을 써야 하나? 내 레일 코드는 API 호출에 관한 것입니다. 가능하면 Plase 코드가 당신이 말하는 것처럼 간단한 경우에도, ...

감사

Answer 1

당신이 적어도 당신 SDS의 기본적인 설명을 포함해야한다을 샘플 문서를 공유 할 수 있습니다.

용도, 범위, 사용 된 패턴 (있는 경우), 데이터베이스 세부 정보는이 문서에서 기본적으로 제공해야하는 섹션입니다. 시퀀스 다이어그램도 아프지 않으며 실제 프로세스와 흐름을 설명하는 데 유용합니다.