좋은 기술 문서 쓰는 6단계 프로세스 ✍🏻
기술 문서 하면 보통 README, 릴리즈 노트 등 소프트웨어와 관련된 내용만 생각하시겠지만 생각보다 더 종류가 다양합니다. 테크 블로그를 운영하기도 하고 사내외에서 이런저런 소통도 하고, 업무 메일 쓰고 있어요. 그래서 사실 우리 모두 테크니컬 라이터가 아닐까 생각해 봅니다. "평생 글쓰기와 헤어질 수 없는 걸 미리 알았다면 책 열심히 읽었을텐데...👀"라고 후회하지 말고 오늘부터 기술 문서 쓰는 연습을 해 봅시다. 시작이 반 이니까요.✍🏻 📋 요약 버전 Q. 좋은 기술 문서 쓰는 방법? A. 차근차근 해보면 이대로 기술 문서 뚝딱 ➀ 독자 이해하기 (내가 사용자라면!?) ➁ 문서화 계획하기 ➂ 문서 초안쓰기(첫 술에 배 부를 수 없음👀) ➃⭐ 문서 편집하기⭐ ➄ 샘플 코드 통합하기 (백 마디 말보다 한 줄의 코드 🙆🏻♀️🙆🏻♂️🙆🏻) ➅ 보조 컨텐츠 추가하기 (백 마디 말보다 하나의 이미지🖼️) 📋 긴 버전 좋은 기술 문서 작성을 위한 6단계 프로세스 👇🏻