| head |
|
|---|
기술 문서는 글로만 구성되지 않아요. 독자에게 내용을 효과적으로 전달하기 위해서는 다양한 시각 요소를 활용하면 좋아요. 시각 요소를 적절하게 사용하면 중요한 내용이 자연스럽게 드러나고, 글로 설명하기 어려운 내용을 보완해서 독자가 내용을 더 쉽게 이해할 수 있어요.
기술 문서에서 주로 사용하는 시각 자료는 다음과 같아요.
- 콜아웃: 중요한 정보나 주의해야 할 내용을 시각적으로 강조해요.
- 리스트: 항목을 간단하게 나열해서 내용을 빠르게 스캔할 수 있어요. 절차가 있으면 번호를 쓰고, 순서와 상관없으면 글머리 기호를 써요.
- 표: 여러 항목을 비교하거나 구조화된 정보를 깔끔하게 정리해요.
- 코드 블록: 예시 코드를 보기 좋게 보여주고 그대로 복사할 수 있어요. 사용 방법이나 설정 예시를 안내할 때 사용해요.
- 인라인 코드: 문장 안에서 함수 이름이나 변수 같은 코드 요소를 구분해서 보여줘요.
- 콜아웃 사용 목적에 따라 색상을 구분하세요.
- 독자에게 꼭 전달하고 싶은 내용을 제목으로 쓰세요