좋은 문서는 좋은 기준에서 시작합니다. 쓰리래빗츠는 매뉴얼웍스로 문서를 작성하면서 쌓아온 경험을 바탕으로 문서 작성 스타일 가이드를 정리했습니다. 문서의 품질과 일관성을 확보하기 위해 만들었으며, 매뉴얼웍스를 사용하는 테크니컬 라이터와 문서 담당자라면 누구에게나 도움이 될 내용을 담았습니다.

왜 스타일 가이드가 필요한가

여러 사람이 함께 문서를 작성하다 보면 같은 개념을 서로 다른 말로 표현하거나, 능동과 수동을 혼용하거나, 표기가 제각각이 되는 일이 생깁니다. 독자 입장에서는 내용은 맞더라도 일관성이 없으면 신뢰감이 떨어집니다. 스타일 가이드는 이런 문제를 예방하는 공통 기준입니다.

쓰리래빗츠 스타일 가이드의 핵심 원칙은 간단합니다. 간결하게, 명확하게, 정중하게.

무엇을 다루는가

이번 스타일 가이드는 크게 네 영역으로 구성됩니다.

스타일과 톤 부분에서는 격식체 사용, 능동태 서술, 동작 중심 표현을 다룹니다. '설정이 저장됩니다' 대신 '설정을 저장합니다'처럼 수동 표현을 능동으로 바꾸는 규칙이 대표적입니다. '할 수 있습니다'를 '합니다'로 바꾸는 기준과 예외도 함께 설명합니다.

표기법과 맞춤법 부분에서는 국립국어원 기준을 따르되 IT 문서의 특수한 상황을 반영합니다. '디렉토리'는 '디렉터리'로, '컨텐츠'는 '콘텐츠'로 표기하는 것처럼 자주 틀리는 외래어 표기, 숫자와 단위 띄어쓰기, 조사 선택 기준을 정리했습니다.

문서 서식 부분에서는 절차 글쓰기와 개념 글쓰기를 구분하는 방법, 표와 코드 단락 사용 기준, 노트·팁·주의 단락을 언제 사용할지를 다룹니다.

시각 요소 부분에서는 메뉴, 버튼, 링크 표기 방식과 그림 및 콜아웃 사용 원칙을 설명합니다.

함께 만들어가는 가이드

스타일 가이드는 완성된 규칙집이 아닙니다. 실제 문서를 작성하다 보면 새로운 사례가 생기고, 기존 기준이 맞지 않는 상황도 만납니다. 이 가이드도 앞으로 계속 보완할 예정입니다.

매뉴얼웍스로 문서를 작성하고 있다면, 이 가이드가 더 좋은 문서를 만드는 데 도움이 되길 바랍니다.