대상 독자
이런 고민을 하는 독자
고객의 요구사항을 정리하는 데 어려움을 겪는 개발자
협업 미팅을 해야 할 때 나의 보고서가 부끄러운 개발자
장애 보고서는 어떻게 써야 할지 난감한 개발자
회의록을 기록하며 업무를 해야 하는 개발자
버튼 텍스트, 오류 메시지 작성 등에 고민이 많은 개발자
남들이 나의 글을 제대로 이해하지 못한다고 생각하는 개발자
전문 테크니컬 라이터가 없는 중소규모의 소프트웨어 기업


“테크니컬 라이팅:
기술이나 과학 분야에서 정보를 정학하게 전달하기 위한 글쓰기”

Microsoft, NAVER, NHN에서 20년
베테랑 테크니컬 라이터의 글쓰기 비법

“개발자 나길동 씨는 아침에 출근해 오늘 할 일을 메모하는 글쓰기로 하루를 시작합니다. 서비스 출시 회의 내용을 정리하는 것도, 관련 부서에 회의 결과와 남은 버그를 공유하는 메일을 쓰는 것도 글쓰기입니다. 다음 주부터 출근하는 신입사원이 봐야 할 코딩 컨벤션도 작성해야 합니다. 출시한 서비스의 버그로 보고된 오류 메시지도 추가로 써야 합니다.
회사 기술 블로그에 JavaScript 성능을 최적화한 경험과 사례를 공유하는 글을 쓰기 시작할 때면 머리가 아파져 옵니다. 한 줄 쓰고 지우고, 한 줄 쓰고 지우고. 몇 시간째 한 페이지를 넘기지 못합니다. 바람이나 쐐야지. 덮어두고 다른 일을 시작하지만, 마음 한켠이 점점 더 무거워집니다.”

[이 책이 제시하는 개발자 나길동 씨를 위한 고민 해결책]

_쉽게 실천할 수 있는 테크니컬 라이팅 기본 규칙
이 책에서 소개하는 기본 규칙만 잘 이해하고 실천한다면 개발자 나길동 씨도 누구나 이해하기 쉽고 빠른 글쓰기를 할 수 있습니다.

_수많은 사례의 예시문을 통한 반복 연습
규칙을 이해했다면 이제는 다양한 사례의 예시문을 반복해서 고쳐보며 연습해야 합니다. 연습 없이 결코 글을 잘 쓸 수 없습니다.

_오랫동안 개발자와 함께한 테크니컬 라이터의 핵심 비법
저자는 오랫동안 개발자와 함께 해왔습니다. 글쓰기 교육, 소프트웨어 관련 테크니컬 라이팅 업무를 하며 익힌 핵심 비법의 정수를 담았습니다.

이 책을 통해 클린 코드 못지않은 클린 테크니컬 라이팅 능력도 갖추길 바랍니다.


_편집자 코멘트
개발자는 고객의 요구사항을 정확하게 정리해내고, 협업 과정에서 문제없이 의사소통을 할 수 있어야 하며, 사용자가 코딩의 결과물을 불편 없이 사용하게 해주어야 한다. 이것은 코딩 외적인 능력에 속하며, 이를 위해 가장 기본적으로 필요한 소양이 바로 기술적 글쓰기, 테크니컬 라이팅 능력이다.

대기업에 속한 개발자들은 전문 테크니컬 라이터에게 필요한 지원을 받을 수 있지만, 수많은 개발자들은 스스로 해결해야 하는 경우가 많다. 이 책은 회사의 지원을 받지 못하는 개발자들을 위해 가장 기본이 되는 기술적 글쓰기의 규칙과 사례를 정리하여 언제나 참고할 수 있는 가이드이다.

바쁜 개발자들을 위해 넘치거나 부족하지 않은 책이 나온 것 같아 편집자로서 정말 기쁘다. 기술서적을 기획, 출간하고 있는 편집자도 이 책을 항상 옆에 끼고 참고하려고 한다.