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