프로그램 문서

소프트웨어 또는 프로그램을 사용자에게 설명하는 모든 서면 텍스트, 일러스트레이션 또는 비디오를 program or software document. 사용자는 프로그래머, 시스템 분석가 및 관리자에서 최종 사용자까지 누구나 될 수 있습니다. 다양한 개발 단계에서 여러 사용자를 위해 여러 문서를 만들 수 있습니다. 사실로,software documentation 전체 소프트웨어 개발 프로세스에서 중요한 프로세스입니다.

모듈 식 프로그래밍에서 문서는 소프트웨어의 다른 모듈이 다른 팀에서 개발되기 때문에 더욱 중요합니다. 개발 팀 이외의 사람이 모듈을 이해하기를 원하거나 이해해야하는 경우 훌륭하고 상세한 문서를 통해 작업을 더 쉽게 수행 할 수 있습니다.

다음은 문서 작성을위한 몇 가지 지침입니다.

• 독자의 관점에서 문서화해야합니다.

• 문서는 명확해야합니다.

• 반복이 없어야합니다

• 산업 표준을 사용해야합니다.

• 문서는 항상 업데이트해야합니다.

• 오래된 문서는 단계적 중단을 기록한 후 단계적으로 제거해야합니다.

문서화의 장점

다음은 프로그램 문서를 제공하는 장점 중 일부입니다.

• 소프트웨어 또는 프로그램의 모든 부분을 추적합니다.

• 유지 관리가 더 쉽습니다.

• 개발자 이외의 프로그래머는 소프트웨어의 모든 측면을 이해할 수 있습니다.

• 소프트웨어의 전반적인 품질 향상

• 사용자 교육 지원

• 사람들이 갑자기 시스템을 떠나는 경우 지식 분산을 보장하고 비용과 노력을 절감합니다.

예제 문서

소프트웨어에는 관련된 여러 유형의 문서가있을 수 있습니다. 중요한 것 중 일부는 다음과 같습니다.

• User manual − 최종 사용자가 소프트웨어의 다양한 기능을 사용하기위한 지침 및 절차를 설명합니다.

• Operational manual − 수행중인 모든 작업과 상호 종속성을 나열하고 설명합니다.

• Design Document− 소프트웨어 개요를 제공하고 설계 요소를 자세히 설명합니다. 다음과 같은 세부 정보를 문서화합니다.data flow diagrams, entity relationship diagrams등

• Requirements Document− 시스템의 모든 요구 사항 목록과 요구 사항의 실행 가능성 분석이 있습니다. 사용자 사례, 실제 시나리오 등이있을 수 있습니다.

• Technical Documentation − 알고리즘, 순서도, 프로그램 코드, 기능 모듈 등과 같은 실제 프로그래밍 구성 요소에 대한 문서입니다.

• Testing Document − 테스트 계획, 테스트 사례, 검증 계획, 검증 계획, 테스트 결과 등을 기록합니다. 테스트는 집중적 인 문서화가 필요한 소프트웨어 개발의 한 단계입니다.

• List of Known Bugs− 모든 소프트웨어에는 매우 늦게 발견되었거나 무해하거나 수정하는 데 필요한 것보다 더 많은 노력과 시간이 소요되기 때문에 제거 할 수없는 버그 또는 오류가 있습니다. 이러한 버그는 나중에 제거 될 수 있도록 프로그램 설명서와 함께 나열됩니다. 또한 버그가 활성화되면 사용자, 구현 자 및 유지 보수 담당자를 돕습니다.