테크니컬 라이팅 - Lists and Tables 1

Tags: technical writing

July 03, 2021

적절한 리스트 종류를 선택하라

다음의 리스트 종류가 있다:

  • bullted list
  • numbered list
  • embedded list

리스트에 순서가 있다면 numbered list를, 순서가 없다면 bulleted list를 사용하라.

embedded list는 다음의 예제처럼 문장 내에 포함되는 리스트이다.

e.g. The llamacatcher API enables callers to create and query llamas, analyze alpacas, delete vicugnas, and track dromedaries.

embedded list는 기술 문서에서는 추천하지 않는다. 가능하면 bulleted list나 numbered list로 바꾸어라.

리스트 아이템의 스타일을 같게 유지하라

다음의 스타일을 같게 유지해야 한다:

  • grammar
  • logical category
  • capitalization
  • punctuation
Examples
  • carrots
  • potatos
  • cabbages

  • Carrots contain lots of Vitamin A.
  • Potatos taste delicious.
  • Cabbages provide oodles of Vitamin K.

numbered list의 아이템은 명령형으로 써라

numbered list는 여러 행동들을 열거 할 때 많이 사용한다. 그럴 경우, 각 아이템을 명령형으로 써라.

마침표를 올바르게 사용하라

리스트 아이템이 문장일 경우 대문자로 시작하고 마침표로 끝내라. 그게 아니라면 소문자로 시작하고 마침표는 제외하라.

Reference