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