부록 F

소프트웨어 기술문서 작성 서식

F.1 개요

본 부록은 소프트웨어 기술자료 작성시 기술자료의 구성 및 세부 작성서식에 대한 지침을 제공하는데 있다. 본 지침은 강제적인 것은 아니나, 규격서의 통일을 위해서는 특별한 사유가 없는 한 따를 것을 권장한다.

F.2 적용문서

본 부록은 아래 문서를 참조하여 작성되었으며, 본 부록에서 규정되지 않은 사항에 대하여는 KS의 작성 서식에 준하여 작성한다.

가. KS A 0001 규격서의 서식(표준서의 서식 및 작성방법)

나. 방위사업관리규정(방위사업청)

다. 표준화업무지침(방위사업청)

라. 무기체계 소프트웨어 개발 및 관리 매뉴얼(방위사업청)

마. 무기체계 소프트웨어 개발 및 관리 실무 지침서(방위사업청)

F.3 문서편집기

소프트웨어 기술문서 작성은 XML(eXtensible Markup Language)로 변환이 가능한 문서편집기(예 : □글, MS word 등)를 사용한다. 각종 자동화 도구의 산출물을 기술문서 대신 제출할 경우 문서 표준 및 세부 구성항목에 대하여 사전 협의를 거친다.

F.4 편집설정

가 편집용지 : A4

용지방향 : 보통(종)

용지여백 : 위쪽    5

	아래쪽 왼쪽 오른쪽 머리말 꼬리말 제본	5 30 25 20 20 0

나 스타일 설정

구 분	정렬	서체	강조	글자 크기	행간	장평	자간	들여 쓰기	비 고
01_바탕글	혼합	신명조		11pt	160	100	-2	0	기본바탕
02_본문_항목제목	혼합	고딕		11pt	160	100	0	0	본문 항목번호 및 제목
03_본문_내용	혼합	신명조		11pt	160	100	-2	0	본문내용, 목차
04_도표그림_제목	가운데	고딕		11pt	160	100	0	0	표 및 그림의 제목
05_도표내용_항목제목	가운데	고딕		10pt	150	100	0	0	표 안의 각 항목 제목
06_도표내용_본문_중앙	가운데	신명조		10pt	150	85	-3	0	표 내용 중앙정렬
07_도표내용_본문_혼합	혼합	신명조		10pt	150	85	-3	3	표 내용 혼합정렬
08_표지_제목	가운데	신명조	강조	21pt	160	100	0	0
09_표지_장비명	가운데	고딕	강조	21pt	160	100	0	0
10_표지_작성자	가운데	신명조		12pt	160	100	0	0	작성자, 검토자, 승인자
11_표지_목차	혼합	신명조		11pt	160	100	0	0	텝설정 : 위치-435.0pt, 종류-오른쪽, 모양-“…”
12_머리꼬리말	혼합	신명조		11pt	160	100	-2	0
13_주석	혼합	굴림		9pt	140	100	0	0
쪽 번호	하단 중앙에 아라비아 숫자, 줄표 넣기

F.5 본문작성

가 본문 입력

1) 본문 작성 시 1단계 항목이 바뀔 때는 페이지를 넘겨서 작성한다.

2) 모든 항목의 제목 다음에 오는 본문내용은 첫 행을 제외한 제목문자와 동일한 위치만큼 들여쓰기 할 것.

3.1.1 소프트웨어의 채택

여기에서는 재사용이 가능한 소프트웨어의 식별, 판단 및 ... ...

3) 내용 없이 다음 항목의 제목만 연결될 때는 행을 안 띄우고 전항의 내용 다음에 제목이 올 때는 한 행을 띄울 것.

3.1 이용 가능한 소프트웨어

3.1.1 소프트웨어의 채택

여기에서는 재사용이 가능한 소프트웨어의 식별, 판단 및 ... ...

□

3.1.2 소프트웨어의 구성도

4) 2단계 항목이 바뀔 때는 두 행을 띄운다.

2 참조문서

다음과 같은 사항 중 해당사항이 있는 경우 그에 대한 개요를 ... ...

2.1 정부문서

□

□

2.2 비정부문서

5) 행이 계속 연결될 때는 행 끝에 엔터키를 치지 말고 계속 연결하여 입력한다.

1.2.1 시스템 개요

주1)XXX 세트 XXX-XXK는 쌍방 무선 전화 통신을 위한 단거리, 휴대용 주파수 변조(FM)방식 송ㆍ수화기로 음성 및 데이터를 고정 방식... ...

주1) XXX 세트는 XXX 체계 중 XXX 소프트웨어, XXX 소프트웨어, XXX 소프트웨어를 통합한 소프트웨어이다.

6) 경고표지부터 쪽 번호를 “새 번호로 시작”으로 초기화할 것

나 표 및 그림 작성

1) 본문 시작 시 표 번호 및 그림번호를 “새 번호로 시작”으로 초기화할 것.

2) 표 및 그림의 개체속성은 “글자처럼 취급”으로 선택하고, 위․아래는 한 행을 띄울 것.

3) 표 번호 및 표 제목은 캡션기능을 사용하여 자동 부여하고 상단에 중앙정렬할 것.

4) 표 바깥쪽 및 제목란 구분선은 굵은 선(약 0.4mm)을 사용할 것.(기본 : 0.12mm)

5) 그림 번호 및 제목은 캡션기능을 사용하여 자동 부여하고 하단에 중앙정렬할 것.

6) 그림 사용 시 “문서에 포함”을 선택하여 작성할 것.

F.6 표준서식

소프트웨어 기술자료의 표준서식은「무기체계 소프트웨어 개발 및 관리 매뉴얼」의 산출물 표준서식을 따르고, 작성 예시는 「무기체계 소프트웨어 개발 및 관리 실무 지침서」의 소프트웨어 기술문서 작성방법 예시를 따른다.