자동화 시스템 표준 세트(KSAS)

USPD(Unified System of Program Documentation)는 프로그램 문서에 대한 국내 표준 세트입니다. 전문 용어에서는 "19번째 손님"이라고도 하는데 이는 하나가 아닌 약 30개의 서로 다른 규제 및 기술 문서에 대해 이야기하고 있기 때문에 완전히 정확하지는 않습니다.

기본적으로 ESPD 표준에는 수명 주기의 다양한 단계에서 프로그램을 설명하는 문서의 구성, 내용 및 실행에 대한 요구 사항이 포함되어 있습니다. 또한 문서 저장 및 업데이트 절차에 대한 여러 문서가 제공됩니다.

ESPD 표준에는 실질적으로 방법론적 구성 요소가 없습니다. 문서를 유용하고, 이해하기 쉽고, 유익하고, 편리하게 만들기 위해 문서를 작성하는 방법을 개발자에게 설명하지 않습니다. 문서 유형 목록과 각 문서에 대한 첫 번째 수준 섹션 목록만 제공합니다. 사실, 각 섹션에 대해 어떤 정보가 표시되어야 하는지가 나와 있습니다.

ESPD 표준은 70년대 후반에 채택되어 원본에 가까운 형태로 우리에게 왔습니다. 이는 대형 컴퓨터를 운영하는 부서별 컴퓨터 센터의 관행을 반영합니다. 그 당시 사람과 컴퓨터 시스템의 상호 작용은 지금과 완전히 다르게 구성되었으며 부피가 큰 원격 제어, 천공 카드 및 인쇄물을 통해 수행되었으며 "단순한 필사자"의 경우 응용 문제를 해결하는 데에도 자격을 갖춘 인력의 중재를 통해 수행되었습니다. . 지금쯤 이러한 표준이 얼마나 구식인지 길게 설명해야 합니까? 사용자 매뉴얼, 관리자 매뉴얼과 같은 일반적인 문서를 모른다고 말하면 충분합니다.

그럼에도 불구하고 계속해서 적극적으로 사용되고 있습니다. 공식적으로 "19번째"에는 현대적인 대안이 있습니다. 시스템 및 소프트웨어 엔지니어링 분야의 일부 ISO/IEC 표준은 러시아어로 번역되어 러시아에서 국가 표준으로 채택되었습니다. 그러나 정부 고객을 포함한 대규모 고객은 서두르지 않고 전환합니다. 이는 그들의 관성(또는 원하는 대로 전통에 대한 충성심)으로 설명될 수 있지만 부분적으로만 설명됩니다.

사실은 작은(최대 3페이지) 분량의 각 ESPD 표준이 다소 형식적인 집합이므로 쉽게 검증 가능문서 또는 문서 세트에 대한 요구 사항. 엄밀히 말하면 문서 개발자가 올바른 형식의 넌센스를 작성하는 것을 막지는 못합니다. 그러나 ESPD는 결과가 무엇으로 구성되어야 하고 어떤 모습이어야 하는지 명확하게 정의하므로 이러한 프레임워크에 맞지 않는 종이 더미는 적어도 즉시 거부할 수 있습니다. 이는 고객과 계약자 모두를 위해 문서를 제출하고 수락하는 작업을 크게 단순화합니다.

반면 ISO/IEC 표준에는 실질적인 성격의 합리적인 규칙이 많이 포함되어 있지만 공식 검증 절차를 상상하기는 어렵습니다. 그러나 다행히 두 표준 세트를 동시에 적용하는 사람은 아무도 없습니다. 다행히도 두 표준은 문서화의 서로 다른 측면과 관련되어 있으며 실제로 서로 모순되지 않습니다.

규제 및 기술 문서의 구성

표준 획득

이 GOST에서 우리는 얻습니다.프로그램 문서 준비에 대한 일반 요구 사항.다음은 가장 중요한 섹션입니다.

• 이 표준은 적용 목적 및 범위에 관계없이 컴퓨터, 컴플렉스 및 시스템에 대한 프로그램 문서 실행에 대한 일반적인 요구 사항을 설정하며 다양한 문서 실행 방법에 대해 USPD (Unified System of Program Documentation) 표준에서 제공합니다. 데이터 캐리어.
• 프로그램 문서는 다음과 같은 일반적인 부분으로 구성됩니다.
• 제목;
• 정보 제공;
• 기초적인;
• 변경사항 등록.
• 표지 부분은 승인서와 제목 페이지로 구성됩니다. 승인 시트 및 제목 페이지 작성 규칙은 GOST 19.104-78에 따라 설정됩니다.
• 정보부분초록과 내용으로 구성되어야 합니다.
• 다양한 유형의 프로그램 문서에 정보 부분을 포함해야 할 필요성은 해당 문서에 대한 관련 ESPD 표준에 의해 확립됩니다.
• 주석은 문서의 목적에 대한 정보와 주요 부분에 대한 간략한 요약을 제공합니다.
• 내용에는 문서 주요 부분의 구조적 요소에 대한 기록 목록이 포함되어 있으며 각 내용에는 다음이 포함됩니다.
• 구조 요소 지정(섹션, 하위 섹션 수 등)
• 구조 요소의 이름;
• 저장 매체에 있는 구조적 요소의 주소(예: 페이지 번호, 파일 번호 등)
• 프로그램 문서의 주요 부분의 구성과 구조는 관련 문서에 대한 ESPD 표준에 따라 설정됩니다.
• 로깅 부분 변경(모든 프로그램 문서에 있어야 함)
• 프로그램 문서의 각 변경 사항은 GOST 19.603-78의 요구 사항에 따라 이 부분에 기록됩니다.

• 이 표준은 적용 목적 및 범위에 관계없이 컴퓨터, 컴플렉스 및 시스템에 대한 프로그램 문서 실행에 대한 규칙을 설정하고 인쇄된 실행 방법에 대해 USPD(Unified System of Program Documentation) 표준에 의해 제공됩니다.
• 이 표준은 프로그램 문서 “프로그램 텍스트”에는 적용되지 않습니다.
• 프로그램 문서의 구성과 구조는 GOST 19.105-78에 따라 설정됩니다.
• 프로그램 문서가 실행됩니다.시트의 한 면에 두 간격으로; 1회 또는 1.5회 간격으로 허용됩니다.
• 프로그램 문서는 다음과 같이 작성됩니다.
• A4 형식의 시트 (GOST 2.301-68) - 타자기 또는 필기로 문서를 준비하는 경우 (양식 1). A3 용지에 그림을 그리는 것이 허용됩니다.

• 프로그램 문서의 자료는 다음 순서로 배열됩니다.
• 제목 부분:
• 승인서(문서의 총 매수에 포함되지 않음)
• 제목 페이지(문서의 첫 번째 페이지)
• 정보 부분:
• 주석;
• 목차;
• 주요 부분:
• 문서의 텍스트(그림, 표 등 포함)
• 응용 프로그램;
• 용어 목록, 약어 목록, 그림 목록, 표 목록, 주제 색인, 참고 문서 목록;
• 로깅 부분 변경:
• 등록 시트 변경.

• 초록은 "ABSTRACT"라는 제목으로 별도의 (번호가 매겨진) 페이지에 배치되며 섹션 번호가 매겨지지 않습니다.
• 주석은 프로그램의 버전을 나타내며 문서의 목적과 내용을 간략하게 설명합니다. 문서가 여러 부분으로 구성된 경우 총 부분 수가 주석에 표시됩니다.
• 문서의 내용은 주석 뒤에 별도의 (번호가 매겨진) 페이지(페이지)에 배치되며, 섹션으로 번호가 매겨지지 않고 문서의 전체 페이지 수에 포함되며 "CONTENTS"라는 제목이 제공됩니다.
• 섹션 제목은 대문자로 작성되며 텍스트의 오른쪽 및 왼쪽 테두리를 기준으로 대칭으로 배치됩니다.
• 하위 섹션 제목은 단락부터 소문자로 작성됩니다(첫 번째 대문자 제외).
• 제목에 단어에 하이픈을 넣을 수 없습니다. 제목 끝에 마침표가 없습니다.

• 제목과 다음 텍스트 사이, 섹션과 하위 섹션 제목 사이의 거리는 다음과 같아야 합니다.
• 타자기로 문서를 실행할 때 - 두 간격.
• 이전 섹션의 텍스트와 동일한 페이지에 텍스트가 작성된 섹션 및 하위 섹션의 경우 텍스트의 마지막 줄과 다음 제목 사이의 거리는 다음과 같아야 합니다.
• 타자 방식을 사용하여 문서를 실행할 때 - 세 가지 타자 간격.
• 섹션, 하위 섹션, 단락 및 하위 단락은 점을 사용하여 아라비아 숫자로 번호를 매겨야 합니다.
• 섹션 내에는 이 섹션에 포함된 모든 하위 섹션, 단락 및 하위 단락에 대해 연속적인 번호가 지정되어야 합니다.
• 하위 섹션의 번호 지정에는 섹션 번호와 이 섹션에 포함된 하위 섹션의 일련 번호가 점으로 구분되어 포함됩니다(2.1, 3.1 등).
• 항과 항이 있는 경우 항과 항의 일련번호(3.1.1, 3.1.1.1 등)를 점 뒤의 항 번호에 붙인다.

프로그램 문서의 텍스트 구조와 해당 섹션, 하위 섹션, 단락 및 하위 단락의 번호 매기기 예입니다.

• 문서의 텍스트는 오해의 가능성을 제외하고 짧고 명확해야 합니다.
• 용어 및 정의는 통일되어야 하며 확립된 표준을 준수해야 하며, 표준이 없을 경우 일반적으로 과학 및 기술 문헌에서 허용되며 용어 목록에 제공됩니다.
• 문서 본문에 필요한 설명을 각주로 제공할 수 있습니다.
• 각주는 글꼴의 위쪽 가장자리 줄에 괄호가 있는 숫자로 표시됩니다(예: "인쇄 장치 2) ..." 또는 "용지 5)".
• 각주가 한 단어를 가리키는 경우 각주 기호는 해당 단어 바로 옆에 표시되지만, 문장 전체를 가리키는 경우에는 문장 끝에 표시됩니다. 각주 텍스트는 페이지 끝에 배치되며 페이지 왼쪽에 3cm 길이의 선을 그어 본문과 구분됩니다.
• 특정 문서에 그림이 두 개 이상 있을 경우 문서 전체에 걸쳐 아라비아 숫자로 번호가 매겨집니다.
• 문서에 수식이 두 개 이상 있는 경우에는 아라비아 숫자로 번호가 지정됩니다. 숫자는 페이지 오른쪽 수식 수준에서 괄호 안에 표시됩니다.
• 수식에 포함된 기호와 수치계수의 의미는 수식 바로 아래에 기재하여야 한다. 각 문자의 의미는 수식에 지정된 순서대로 새 줄에 인쇄됩니다. 성적표의 첫 번째 줄은 "where"라는 단어로 시작해야 하며 그 뒤에는 콜론이 없어야 합니다.
• 프로그램 문서에서는 표준(기업 표준 제외), 기술 사양 및 기타 문서(예: 국가 감독 기관 문서, 소련 국가 건설 위원회의 규칙 및 규정)에 대한 참조가 허용됩니다. 표준 및 기술 사양을 참조할 때 해당 명칭이 표시됩니다.
• 문서 전체 또는 해당 섹션(문서의 지정 및 이름, 섹션 또는 부속서의 번호 및 이름 표시)을 참조해야 합니다. 섹션이나 응용 프로그램을 반복적으로 참조하는 경우 번호만 표시됩니다.
• 텍스트와 표에 대한 참고 사항은 참조 및 설명 데이터만을 나타냅니다.
• 하나의 메모에는 번호가 매겨져 있지 않습니다. “Note”라는 단어 뒤에 마침표를 찍습니다.
• 여러 개의 음표에는 점이 있는 아라비아 숫자를 사용하여 순서대로 번호를 매겨야 합니다. "Note"라는 단어 뒤에 콜론을 입력합니다.
• 본문 내 단어의 약어 사용 및 그림 아래의 비문은 허용되지 않습니다.
• 그림이 포함된 자료, 표 또는 지원 텍스트는 부록 형식으로 제공될 수 있습니다.
• 각 신청서는 오른쪽 상단에 "APPENDIX"라는 단어가 표시된 새 페이지에서 시작해야 하며 주제 제목이 대문자로 텍스트와 대칭으로 작성되어야 합니다.(결국 프로젝트를 생성하려면 변경등록 시트만 있으면 됩니다.)
  
  • 이 표준은 USPD(Unified System of Program Documentation) 표준에 따라 제공되고 인쇄된 프로그램 문서를 변경하기 위한 규칙을 설정합니다.
  이 GOST에는 많은 양의 정보가 포함되어 있고 이 페이지의 공간을 절약하기 위해 직접 보시기를 권장합니다. GOST 19.604-78* . 준비된 디자인 예시"등록 시트 변경"다운로드 섹션에 제공된 모든 프로그램 문서에서 볼 수 있습니다.
  
  맨 위로
  ==================================

G O S U D A R S T V E N N Y S T A N D A R T S O Y W A S S R

1978년 12월 18일 No. 3350의 소련 국가 표준위원회 법령에 따라 도입 날짜가 설정되었습니다.

1980년 1월 1일부터

이 표준은 적용 목적 및 범위에 관계없이 컴퓨터, 컴플렉스 및 시스템에 대한 프로그램 문서 실행에 대한 일반적인 요구 사항을 설정하며 다양한 문서 실행 방법에 대해 USPD (Unified System of Program Documentation) 표준에서 제공합니다. 데이터 캐리어.

이 표준은 정보 부분 설계에 대한 일반 요구 사항 측면에서 ST SEV 2088-80을 준수합니다(참조 부록 참조).

1. 일반 요구 사항

1.1. 프로그램 문서는 다양한 유형의 저장 매체에 표시될 수 있습니다.

1.2. 프로그램 문서는 다음과 같은 일반적인 부분으로 구성됩니다.

제목;

정보 제공;

기초적인;

변경사항 등록.

1.3. 각 데이터 매체의 문서 및 해당 부분 실행에 대한 규칙은 해당 데이터 매체의 문서 실행 규칙에 대한 ESPD 표준에 의해 설정됩니다.

2. 제목 부분

2.1. 표지 부분은 승인서와 제목 페이지로 구성됩니다. 승인 시트 및 제목 페이지 작성 규칙은 GOST 19.104-78에 따라 설정됩니다.

3. 정보 부분

3.1. 정보 부분은 초록과 내용으로 구성되어야 합니다.

3.2. 다양한 유형의 프로그램 문서에 정보 부분을 포함해야 할 필요성은 해당 문서에 대한 관련 ESPD 표준에 의해 확립됩니다.

3.3. 주석은 문서의 목적에 대한 정보와 주요 부분에 대한 간략한 요약을 제공합니다.

구조 요소 지정(섹션, 하위 섹션 수 등)

구조 요소의 이름;

저장 매체에 있는 구조적 요소의 주소(예: 페이지 번호, 파일 번호 등)

문서 주요 부분의 구조적 요소를 지정하고 해당 주소를 지정하는 규칙은 해당 데이터 매체에 문서를 작성하는 규칙에 대한 ESPD 표준에 의해 설정됩니다.

4. 주요 부분

4.1. 프로그램 문서의 주요 부분의 구성과 구조는 관련 문서에 대한 ESPD 표준에 따라 설정됩니다.

5. 변경등록 부분

5.1. 프로그램 문서의 각 변경 사항은 GOST 19.603-78의 요구 사항에 따라 이 부분에 기록됩니다.

부록 참고자료

GOST 19.105-78 ST SEV 2088-80 준수에 관한 정보 데이터

비서. 3 GOST 19.105-78은 섹션에 해당합니다. 4(4.2, 4.3항) ST SEV 2088-80.

(추가신설. 개정 제1호)

* 변경 번호 1로 재발행(1987년 11월), 1981년 9월 승인(IUS 11-81)

GOST 19.105-78

그룹 T55

주간 표준

프로그램 문서의 통합 시스템

소프트웨어 문서에 대한 일반 요구 사항

프로그램 문서화를 위한 통합 시스템. 프로그램 문서에 대한 일반 요구 사항

MKS 35.080

도입일 1980-01-01

1978년 12월 18일자 소련 국가 표준 위원회 법령 N 3350에 따라 시행 날짜는 01/01/80으로 설정되었습니다.

개정판(2010년 1월), 수정안 1호, 1981년 9월 승인(IUS 11-81).


이 표준은 적용 목적 및 범위에 관계없이 컴퓨터, 컴플렉스 및 시스템에 대한 프로그램 문서 준비에 대한 일반적인 요구 사항을 설정하며 다양한 문서 실행 방법에 대해 USPD (Unified System of Program Documentation) 표준에서 제공합니다. 데이터 캐리어.

이 표준은 정보 부분 설계에 대한 일반 요구 사항 측면에서 ST SEV 2088-80*을 준수합니다(부록 참조).
________________
* 본문에 언급된 국내외 문서에 대한 접근권한은 고객지원팀에 문의하여 얻을 수 있습니다. - 데이터베이스 제조업체의 메모.

(변경판, 수정안 1호).

1. 일반 요구 사항

1. 일반 요구 사항

1.1. 프로그램 문서는 다양한 유형의 저장 매체에 표시될 수 있습니다.

1.2. 프로그램 문서는 다음과 같은 일반적인 부분으로 구성됩니다.

제목;

정보 제공;

기초적인;

변경사항 등록.

1.3. 각 데이터 매체의 문서 및 해당 부분 실행에 대한 규칙은 해당 데이터 매체의 문서 실행 규칙에 대한 ESPD 표준에 의해 설정됩니다.

2. 제목 부분

2.1. 표지 부분은 승인서와 제목 페이지로 구성됩니다.

GOST 19.104-78에 따른 승인 시트 및 제목 페이지 작성 규칙.

3. 정보 부분

3.1. 정보 부분은 초록과 내용으로 구성되어야 합니다.

3.2. 다양한 유형의 프로그램 문서에 정보 부분을 포함해야 할 필요성은 해당 문서에 대한 관련 ESPD 표준에 의해 확립됩니다.

3.3. 주석은 문서의 목적에 대한 정보와 주요 부분에 대한 간략한 요약을 제공합니다.

3.4. 콘텐츠에는 문서 주요 부분의 구조적 요소에 대한 기록 목록이 포함되어 있으며 각 항목에는 다음이 포함됩니다.

구조 요소 지정(섹션, 하위 섹션 수 등)

구조 요소의 이름;

저장 매체에 있는 구조적 요소의 주소(예: 페이지 번호, 파일 번호 등)

문서 주요 부분의 구조적 요소를 지정하고 해당 주소를 지정하는 규칙은 해당 데이터 매체에 문서를 작성하는 규칙에 대한 ESPD 표준에 의해 설정됩니다.

4. 주요 부분

4.1. 프로그램 문서의 주요 부분의 구성과 구조는 관련 문서에 대한 ESPD 표준에 따라 설정됩니다.

5. 변경등록 부분

5.1. 프로그램 문서의 각 변경 사항은 GOST 19.603-78의 요구 사항에 따라 이 부분에 기록됩니다.

부록(참조). GOST 19.105-78 ST SEV 2088-80 준수에 관한 정보 데이터

애플리케이션
정보

GOST 19.105-78의 섹션 3은 섹션 4(4.2, 4.3절) ST SEV 2088-80에 해당합니다.

(추가로 도입됨, 수정안 1호).



전자문서텍스트
Kodeks JSC에서 준비하고 다음에 대해 검증했습니다.
공식 출판물
프로그램 문서의 통합 시스템:
국가 표준 수집. -
M.: 스탠다드인폼, 2010

G O S U D A R S T V E N N Y S T A N D A R T S O Y W A S S R

1978년 12월 18일 No. 3350의 소련 국가 표준위원회 법령에 따라 도입 날짜가 설정되었습니다.

1980년 1월 1일부터

이 표준은 적용 목적 및 범위에 관계없이 컴퓨터, 컴플렉스 및 시스템에 대한 프로그램 문서 실행에 대한 일반적인 요구 사항을 설정하며 다양한 문서 실행 방법에 대해 USPD (Unified System of Program Documentation) 표준에서 제공합니다. 데이터 캐리어.

이 표준은 정보 부분 설계에 대한 일반 요구 사항 측면에서 ST SEV 2088-80을 준수합니다(참조 부록 참조).

1. 일반 요구 사항

1.1. 프로그램 문서는 다양한 유형의 저장 매체에 표시될 수 있습니다.

1.2. 프로그램 문서는 다음과 같은 일반적인 부분으로 구성됩니다.

• 제목;
• 정보 제공;
• 기초적인;
• 변경사항 등록.

1.3. 각 데이터 매체의 문서 및 해당 부분 실행에 대한 규칙은 해당 데이터 매체의 문서 실행 규칙에 대한 ESPD 표준에 의해 설정됩니다.

2. 제목 부분

2.1. 표지 부분은 승인서와 제목 페이지로 구성됩니다. 승인 시트 및 제목 페이지 작성 규칙은 GOST 19.104-78에 따라 설정됩니다.

3. 정보 부분

3.1. 정보 부분은 초록과 내용으로 구성되어야 합니다.

3.2. 다양한 유형의 프로그램 문서에 정보 부분을 포함해야 할 필요성은 해당 문서에 대한 관련 ESPD 표준에 의해 확립됩니다.

3.3. 주석은 문서의 목적에 대한 정보와 주요 부분에 대한 간략한 요약을 제공합니다.

• 구조 요소 지정(섹션, 하위 섹션 수 등)
• 구조 요소의 이름;
• 저장 매체에 있는 구조적 요소의 주소(예: 페이지 번호, 파일 번호 등)

문서 주요 부분의 구조적 요소를 지정하고 해당 주소를 지정하는 규칙은 해당 데이터 매체에 문서를 작성하는 규칙에 대한 ESPD 표준에 의해 설정됩니다.

4. 주요 부분

4.1. 프로그램 문서의 주요 부분의 구성과 구조는 관련 문서에 대한 ESPD 표준에 따라 설정됩니다.

5. 변경등록 부분

5.1. 프로그램 문서의 각 변경 사항은 GOST 19.603-78의 요구 사항에 따라 이 부분에 기록됩니다.

애플리케이션
정보

GOST 19.105-78 준수에 관한 정보 데이터
세인트 SEV 2088-80

(추가신설. 개정 제1호)

* 변경 번호 1로 재발행(1987년 11월), 1981년 9월 승인(IUS 11-81)