참조 페이지는 표준 레이아웃을 따라야 합니다. 이를 통해 사용자는 원하는 정보를 더 빨리 찾을 수 있으며 작성자가 명령의 모든 관련 측면을 문서화하도록 권장합니다. 일관성은 사이에서만 요구되는 것이 아닙니다.PostgreSQL참조 페이지뿐 아니라 운영 체제 및 기타 패키지에서 제공하는 참조 페이지도 포함되어 있습니다. 따라서 다음과 같은 지침이 개발되었습니다. 이는 대부분 다양한 운영 체제에서 확립한 유사한 지침과 일치합니다.
실행 가능한 명령을 설명하는 참조 페이지에는 다음 섹션이 순서대로 포함되어야 합니다. 해당되지 않는 부분은 생략 가능합니다. 추가 최상위 섹션은 특별한 상황에서만 사용해야 합니다. 종종 해당 정보는“사용법”섹션.
이 섹션은 자동으로 생성됩니다. 여기에는 명령 이름과 해당 기능에 대한 반문장 요약이 포함되어 있습니다.
이 섹션에는 명령의 구문 다이어그램이 포함되어 있습니다. 개요에는 일반적으로 각 명령줄 옵션이 나열되어서는 안 됩니다. 그건 아래에서 이루어집니다. 대신 입력 및 출력 파일의 위치와 같은 명령줄의 주요 구성 요소를 나열하세요.
명령이 수행하는 작업을 설명하는 여러 단락.
각 명령줄 옵션을 설명하는 목록입니다. 옵션이 많으면 하위 섹션을 사용할 수 있습니다.
프로그램이 성공을 위해 0을 사용하고 실패를 위해 0이 아닌 값을 사용한다면 이를 문서화할 필요가 없습니다. 0이 아닌 다양한 종료 코드 뒤에 의미가 있는 경우 여기에 나열하세요.
프로그램의 하위 언어 또는 런타임 인터페이스를 설명하십시오. 프로그램이 대화형이 아닌 경우 일반적으로 이 섹션을 생략할 수 있습니다. 그렇지 않은 경우 이 섹션은 런타임 기능을 설명하기 위한 포괄적인 섹션입니다. 해당하는 경우 하위 섹션을 사용하세요.
프로그램이 사용할 수 있는 모든 환경 변수를 나열합니다. 완전해지려고 노력하세요. 심지어는 겉으로는 사소해 보이는 변수도쉘사용자가 관심을 가질 수 있습니다.
프로그램이 암시적으로 접근할 수 있는 모든 파일을 나열합니다. 즉, 명령줄에 지정된 입력 및 출력 파일을 나열하지 않고 구성 파일 등을 나열합니다.
프로그램이 생성할 수 있는 비정상적인 출력을 설명하십시오. 가능한 모든 오류 메시지를 나열하지 마십시오. 이것은 많은 작업이며 실제로는 거의 사용되지 않습니다. 그러나 오류 메시지가 사용자가 구문 분석할 수 있는 표준 형식을 가지고 있다면 여기에서 이를 설명할 수 있습니다.
다른 곳에 맞지 않는 모든 것, 특히 버그, 구현 결함, 보안 고려 사항, 호환성 문제.
예
프로그램 역사에 몇 가지 주요 이정표가 있었다면 여기에 나열될 수 있습니다. 일반적으로 이 섹션은 생략될 수 있습니다.
저자 (기고 섹션에서만 사용됨)
상호 참조, 다음 순서로 나열됨: 기타포스트그레SQL명령 참조 스포츠 토토,PostgreSQLSQL 명령 참조 스포츠 토토, 인용PostgreSQL설명서, 기타 참조 페이지(예: 운영 체제, 기타 패키지), 기타 문서. 같은 그룹에 있는 항목은 알파벳순으로 나열됩니다.
SQL 명령을 설명하는 참조 페이지에는 다음 섹션이 포함되어야 합니다: 이름, 개요, 설명, 매개변수, 출력, 참고, 예, 호환성, 기록, 참조. 매개변수 섹션은 옵션 섹션과 유사하지만 명령의 어떤 절을 나열할 수 있는지에 대한 더 많은 자유가 있습니다. 출력 섹션은 명령이 기본 명령 완료 태그가 아닌 다른 것을 반환하는 경우에만 필요합니다. 호환성 섹션에서는 이 명령이 SQL 표준을 어느 정도 준수하는지 또는 호환되는 다른 데이터베이스 시스템을 설명해야 합니다. SQL 명령의 참고 항목 섹션에는 프로그램에 대한 상호 참조 전에 SQL 명령이 나열되어야 합니다.
문서에 올바르지 않은 내용이 있으면 일치하지 않습니다. 특정 기능에 대한 경험이 있거나 추가 설명이 필요한 경우 이용해주세요이 양식문서 문제를 보고합니다.