컴퓨터공학/네트워크

[NET] Cisco style guide

skokieh 2023. 5. 16. 15:23
728x90

Cisco Technical Content Style Guide
세로 막대( | ) 서로 배타적인 별도의 대체 인수(sub para)를 구분합니다.
예: req-qos {best-effort | controlled-load | guaranteed-delay}

대괄호([ ])는 선택적(optional) 요소를 나타냅니다. 예: [no] ip route-cache [cbus]

중괄호({ })는 필수(required) 항목을 나타냅니다. 예: access-list number [{permit | deny}]

대괄호 안의 중괄호([{ }])는 선택적 요소([], optional)내의 필수({}, required)선택 항목을 나타냅니다.

꺾쇠 괄호(< >)는 기울임꼴을 허용하지 않는(not) 컨텍스트의 인수를 나타내고, 예를 들어 비밀번호와 같이 화면에 나타나지 않는 사용자가 입력하는 문자열을 나타냅니다.

Bold는 '명령과 키워드'를 나타냅니다.

기울임꼴(italic)은 사용자 '변수'를 나타냅니다.

ref:
https://www.cisco.com/c/ko_kr/support/docs/dial-access/asynchronous-connections/17016-techtip-conventions.html