절차

  1. 계획 (40%)
    • 정보 수집, 개념 이해 (브레인 스토밍, 마인드맵)
    • 작성 목적 설정, 독자 설정, 정보 추리기, 구조화, 일정 짜기 (목차)
  2. 작성 (20%)
    • 내용 작성, 용어정리 (초안)
  3. 수정 (40%)
    • 자가 검토 및 수정, 내용 검증, 사용성 확인 (체크리스트)
    • 동료 리뷰, 피드백 반영
    • 퇴고

계획

  • 주제
  • 목적
  • 절차
  • 구조

초안작성

  • 정확성
  • 명확성
  • 간결성
    • 긴문장 나누기
    • 불필요한 단어 제거
    • 리스트 절차는 3 depth 이상 쓰지 말기
  • 일관성
    • 일관된 용어, 스타일 가이드 (문서템플릿)
    • 구글 개발자 문서 스타일 가이드 (https://developers.google.com/style/)
  • 테크니컬 라이팅 원칙
    정확성, 명확성, 간결성, 일관성
    
- 도표 등 시각화 자료는 간결한걸 넣을 수록 좋음

수정

  • 읽으면서, 자가검토
  • 원칙 재 검토
    • 정확성, 명확성, 간결성, 일관성
  • 링크 삽입 시 문서제목, 목적 명시 (여기, 이곳 등 대명사 사용 금지)