프로젝트 작성 방법

Question

방금 ​​비교적 작은 프로젝트 (여러 모듈에서 ~ 3000 줄의 코드)를 완료했으며 프로젝트에 대한 문서를 작성하도록 요청 받았습니다. 이전에 다른 프로그래머를위한 코드를 대부분 작성 했으므로이 문제를 어떻게 해결해야할지 모르겠습니다. 각 모듈에 대해 설명하고, 각 객체에 대한 UML 다이어그램을 작성하고, 주석을 확장하면됩니까? 이 템플릿을 사용할 수 있습니까? 누구나 표준 문서를 작성해야한다면 도움/조언에 감사드립니다.

Answer 1

"표준"문서는별로 없습니다. "Javadoc"스타일 API 문서는 사용자가 얻는 것만큼이나 비슷합니다. 보다 견고한 요구 사항을 확보하십시오. 어떤 종류의 문서가 고객에게 필요합니까? 모든 클래스에 대한 UML 다이어그램은 훌륭하고 때로는 유용하지만, 향후 프로젝트에 더 많은 시간을 할애 할 수 있습니다.

Answer 2

최소한 당신은

• 소프트웨어를 구축하는 방법을
• 는 파일 및 도구 "매니페스트"
• 릴리스 정보를 요구
• 설치하는 방법을 문서화 할 필요가으로부터 변경된 것 이전에 릴리스 된 버전
• 라이센스 및 저작권 정보

그런 소프트웨어를 사용하는 방법에 따라, 당신은 할 수 있습니다

• 사용 설명서
• 당신은 DOD-STD-2178A 데이터 항목에 대한 설명을 검토하는 것보다 훨씬 더 할 수

Answer 3

API 문서 소프트웨어 디자인 문서 및 버전 설명 문서.

SDD는 소프트웨어 설계를 설명합니다. VDD는 패키지를 설치 (압축을 풀고 컴파일,로드, 설정)하는 방법을 포함하여 패키징을 설명합니다.