가이드 본문 요소
본문은 이 목록의 블록만 조합해서 만듭니다. 페이지 Blade에는 데이터만 적고
마크업은 공통 렌더러가 만들기 때문에, 새 요소가 필요하면 여기와
article.blade.php에 함께 추가합니다.
- 인라인 스타일 금지
- 색은 --ds-* 토큰만
본문 문자열 인라인 표기
모든 블록의 텍스트에서 아래 네 가지 표기를 쓸 수 있습니다. 그 밖의 HTML은 그대로 escape되므로 본문에 태그를 직접 적지 않습니다.
| 적는 방법 | 결과 | 언제 씁니까 |
|---|---|---|
[[팀 등록]] |
팀 등록 | 화면의 버튼·입력칸 이름 |
((조직·계정 > 사용자)) |
조직·계정사용자 | 앱 메뉴 경로 |
`team_id` |
team_id |
주소, 파일명, 설정값 |
**0명** |
0명 | 문장 안의 핵심 값 하나 |
단축키가 필요하면 Ctrl
S 처럼
.ds-product-guide-key를 씁니다.
블록 목록
각 칸의 회색 칩이 페이지 데이터에 적을 키입니다.
본문 문단
기본 서술. 한 문단은 두세 문장까지만 씁니다.
- type text
- text
관리자앱의 조직·계정팀을 선택합니다. 관리자 로그인이 필요하며 별도 구독은 필요하지 않습니다.
중간 제목
한 섹션 안을 더 나눌 때만 씁니다. 우측 목차에는 올라가지 않습니다.
- type subtitle
- text
기본 서버 상태
콜아웃 3종
참고 / 주의 / 필요 조건. 연한 색면과 라벨로 구분하고 아이콘은 쓰지 않습니다.
- type note
- variant info · warn · req
- text
절차
순서가 실제로 중요한 작업에만 씁니다. 한 단계는 한 동작으로 끊습니다.
- type steps
- items[]
- 1 목록 오른쪽 아래에서 팀 등록을 선택합니다.
- 2 필수 항목인 ‘팀 이름’을 입력합니다.
- 3 등록을 선택하면 목록 맨 위에 표시됩니다.
순서 없는 나열
증상·상태·구성 요소처럼 순서가 없는 항목. 라벨을 앞에 둡니다.
- type facts
- items[] {label, text}
- 1 등록 버튼이 비활성입니다.필수 항목과 중복 이름을 확인합니다.
- 2 오류 알림이 표시됩니다.내용을 확인하고 목록을 다시 불러옵니다.
캡처 주석
캡처 아래에서 번호로 풀어 설명합니다. 캡처의 번호와 순서가 같아야 합니다.
- type callouts
- items[] {label, text}
- 1 팀 이름 — 선택하면 수정 창이 열립니다.
- 2 소속 인원 — 현재 이 팀에 속한 사용자 수입니다.
입력 항목
입력칸의 제약을 적습니다. 필수·선택 배지를 함께 씁니다.
- type fields
- items[] {name, badge, description}
- badge required · optional
화면 캡처
파일이 실제로 있을 때만 렌더링됩니다. width는 10~100 사이 10 단위,
wide는 본문보다 넓게, hotspots는 이미지 위 번호입니다.
- type figure
- src
- alt
- number
- caption
- width
- wide
- hotspots[]
표
비교, 선택 기준, 증상·원인·해결처럼 축이 두 개 이상일 때 씁니다.
- type table
- head[]
- rows[][]
| 연결 방식 | 구독 | 모델 선택 |
|---|---|---|
| Dotory AI | 필요 | 제공 목록에서 선택 |
| BYOK AI | 불필요 | 회사 API 키로 조회한 모델 |
| Self-hosted AI | 불필요 | 회사 서버에 설치한 모델 |
체크리스트
순서가 없고 확인만 필요한 준비 항목. 한 줄이면 마침표를 쓰지 않습니다.
- type checklist
- items[]
- 업무 폴더로 나눌 실제 업무 단위를 정했습니다
- 자료를 볼 사용자와 권한 그룹을 준비했습니다
- 올릴 자료가 지원하는 파일 형식인지 확인했습니다
값 · 코드
주소나 설정값처럼 그대로 옮겨 적어야 하는 내용.
- type code
- label
- text
http://127.0.0.1:11434
완료 확인
절차 끝에서 ‘제대로 됐는지’를 알려 줍니다. 주의 콜아웃과 겹치지 않게 씁니다.
- type done
- text
나란히 비교
두 방식이나 두 플랫폼을 나란히 둘 때. 셋 이상이면 표를 씁니다.
- type split
- items[] {title, text}
한 번에 한 명을 등록합니다. 입력 항목을 꼼꼼히 확인할 때 씁니다.
표 형태로 여러 명을 한 번에 처리합니다. 최대 100명까지 입력합니다.
공지 배너
문서 전체에 걸리는 상태 안내. 문서 머리 바로 아래에 한 번만 씁니다.
- article notice 또는 type notice
- label
- text
조건 배지
문서 제목 아래에서 권한·플랫폼 조건을 한 줄로 알립니다.
- article conditions[]
- 문자열
- 관리자 권한
- 관리자앱
자주 묻는 질문
문서 끝의 예외 상황. 질문은 사용자가 쓰는 말로, 답은 두세 문장 안에 끝냅니다. 사용자가 바로 알아야 할 내용은 접이식 안에 숨기지 않습니다.
- article faq[]
- {q, a}
소속 사용자가 있는데 팀을 삭제할 수 있나요?
팀과 권한 그룹은 무엇이 다른가요?
관련 가이드
문서 맨 끝. 등록된 slug만 카드로 표시되므로 아직 없는 문서를 적어도 화면이 깨지지 않습니다.
- article related[]
- {slug, title, description}
바깥 링크
문서 끝의 ‘관련 가이드’와 달리 본문 흐름 안에서 가이드가 아닌 URL로 보냅니다. 다운로드처럼 다른 페이지로 나가야 절차가 이어지는 곳에만 씁니다.
- block links
- items[] {url, title, description, external}