테크니컬 라이팅 - ChoDragon9/posts GitHub Wiki
개념 이해
정의
- 다른 사람과 소통하기 위해 원하는 목적을 달성할 수 있도록 하는 글쓰기 기법
- 복잡한 기술 정보를 정확하게 전달하고 효과적으로 전달하기 위한 문서 작성 기술
- 독자 입장에서 독자가 필요한 정보를 이해하기 쉽게 전달
적용
- 사용자 가이드, 레퍼런스, 장애 보고서, 기술 블로그, 개발자 문서, 릴리즈 노트, 업무 공유
- 지라, 깃헙, 위키 등
중요한 이유
- 부정확하고 모호한 글은 시간 낭비와 브랜드 이미지에 부정적인 영향을 미침
- 알고 있는 지식의 양을 모두 전달하기 위해
테크니컬 라이팅의 절차
큰 절차
- 계획: 40%
- 작성: 20%
- 수정: 40%
세부 절차
- Prewriting
- 정보 수집 및 개념 이해
- 툴: 브레인 스토밍, 마인트맵
- Planning
- 작성 목적 설정
- 독자 설정
- 정보 추리기
- 구조화
- 작업 일정 짜기
- 툴: 목차
- Drafting
- Reflection
- 자가 검토&수정
- 문서 내용 검증
- 사용성 확인
- 툴: 체크리스트, QA 시트
- Review
- Revision
- Proofreading
적용
계획
- 주제/목적/독자/구조
- 구조
- 서술형 구조: 서론-본문-참조 (예: 기술 블로그)
- 절차 기반 구조: 시간의 흐름에 따른 절차 안내 (예: 사용자 가이드)
- 라이브러리 구조: 정보 나열 (예: 레버런스 가이드)
- 시스템 기반 구조: 공간에 따른 안내 (예: 시스템 가이드, 제품 설명서)
초안 작성
- 작성한 목차를 토대로 내용 채우기
- 사용자의 입장을 고려하여 작성하기
- 두괄식으로 작성하기
- 가장 중요한 정보 => 이해를 위해 필요한 세부 뒷받침 내용 => 알면 좋은 정보 순서로 작성
- 문단에는 하나의 주제를 작성
- 핵심 문장(주어 + 서술어) + 보충 문장(주어 + 목적어 + 서술어)
- 보충 문장: 핵심 문장을 논리적으로 뒷받침 해주는 문장
테크니컬 라이팅 원칙 적용
- 정확성: 정확한 정보와 사실만 전달
- 개념, 논리, 데이터의 해석이 정확하게 작성하기
- 부정확한 정보는 차라리 삭제하기
- 주관적인 생각과 추측은 배제하기
- 명확성: 내용의 모호함으로 독자를 헷갈리게 하지 말자
- 대상을 생략하지 않고 명확히 하기
- 서술어의 수식 관계 맞추기
- 중의적인 의미를 가진 문장 피하기
- 주관적으로 해석이 다르게 되거나 애매한 표현 피하기 (예: 느리게, 약간)
- (O) 능동형, 명령문, 긍정문, 현재형
- (X) 수동형, 부정문, 평서문
- 간결성: 빠르고 정확하게 정보를 이해 하도록 쓰자
- 수식어가 많거나 너무 긴 문장은 의미 단위로 나누기
- 핵심만 남기고 버리기, 불필요한 단어 제거하기
- 장황한 서술형 문장은 목록화하기
- 순서 상관 없는 정보의 나열은
-, * 사용
- 절차는 숫자 리스트
- 일관성: 한 사람이 쓴 느낌을 주도록 작성
- 일관된 용어(공식 용어)
- 서식, 표기법 사용
- 표기법에 맞는 서비스 이름 사용
시각적 자료 추가하기
- 내용의 이해를 돕기 위해 스크린샷, 표, 순서도, 삽화 추가
- 복잡한 데이터는 오히려 사용자의 이해를 방해, 필요한 정보만 간략하게
수정
실습