분야
분야 전체
크레마클럽 허브

개발자를 위한 글쓰기 가이드

예제로 배우는 테크니컬 라이팅 핵심 비법

유영경 | 로드북 | 2022년 1월 24일 한줄평 총점 8.6 (5건)정보 더 보기/감추기
  •  종이책 리뷰 (2건)
  •  eBook 리뷰 (0건)
  •  한줄평 (3건)
분야
IT 모바일 > IT 전문서
파일정보
PDF(DRM) 9.72MB
지원기기
크레마 PC(윈도우 - 4K 모니터 미지원) 아이폰 아이패드 안드로이드폰 안드로이드패드 전자책단말기(일부 기기 사용 불가) PC(Mac)

개발자를 위한 글쓰기 가이드

이 상품의 태그

책 소개

개발자가 코딩만 잘하면 된다? 고객의 요구사항 분석을 제대로 글로 옮기지 못한다면 무슨 일이 발생할까? 장애 발생 시 공지문을 작성해야 하는데, 빠짐없이 정확하게 작성할 수 있을까? 오류와 확인 메시지는 제대로 쓸 수 있을까? UI에 들어가는 텍스트는? 소프트웨어 제품 출시 후 사용자 가이드는 어떻게 만들어야 할까?

개발자는 코딩 영역 외에도 이렇게 수많은 글쓰기 문제에 직면한다. 이를 위해 저자는 테크니컬 라이터로서 20년 이상 개발자와 함께하며 얻는 핵심 노하우를 이 책 한 권에 정리하였다. 옆에 두고 항상 참고할 수 있는 개발자만을 위한 글쓰기 가이드이다.

샘플원고 → https://roadbook.co.kr/246

상세 이미지

상세 이미지

저자 소개 (1명)

저 : 유영경
Microsoft에서 운 좋게 테크니컬 라이터라는 직무를 알게 된 후 20년 이상 이를 업으로 삼고 있다. NAVER 기술문서팀 팀장을 거쳐 현재는 NHN에서 테크니컬 라이팅, UX 라이팅, IT 콘퍼런스 기획 총괄, 글쓰기 교육 등을 전담하고 있다. 『웹 기획자가 알아야 할 서비스 글쓰기의 모든 것』(2013, 위키북스)을 공동 집필했다. Microsoft에서 운 좋게 테크니컬 라이터라는 직무를 알게 된 후 20년 이상 이를 업으로 삼고 있다. NAVER 기술문서팀 팀장을 거쳐 현재는 NHN에서 테크니컬 라이팅, UX 라이팅, IT 콘퍼런스 기획 총괄, 글쓰기 교육 등을 전담하고 있다. 『웹 기획자가 알아야 할 서비스 글쓰기의 모든 것』(2013, 위키북스)을 공동 집필했다.

출판사 리뷰

대상 독자
이런 고민을 하는 독자

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


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

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


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

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

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

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

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

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


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

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

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

종이책 회원 리뷰 (2건)

글쓰기 가이드
내용 평점5점   편집/디자인 평점5점 | c*****8 | 2021.03.08

프로그래밍만 잘하면 잘 나가는 시절이 있었던 것 같은데 요즘은 그렇지 않은 것 같다. 은근히 개발자도 문서 작성을 잘 해야 하는 분위기이다. 이 책은 개발자가 문서 작성할 때 옆에 두고 수시로 볼 수 있는 정말 가이드 같은 책이다. 이제는 그냥 감으로 쓰지 않고 체계적으로 쓸 수 있을 것 같은 기분이 든다. 문서를 작성하면서 뭔가 아쉬운 점이 있었는데 이 책을 읽고 그 아쉬운 점에 대한 해결책을 찾은 것 같다

이 리뷰가 도움이 되었나요? 접어보기
개발자를 위한 글쓰기 가이드
내용 평점4점   편집/디자인 평점4점 | j***o | 2021.02.28

이 책은 287 페이지 정도의 책으로

그리 두껍지 않아 전철에서 가지고 다니면서 읽어도 될 정도의 크기인 듯 하다.

 

책은

앞부분에 글쓰기를 어떻게 하면 좋은지에 대한

내용을 다루고 있고

 

뒷부분은

업무시 유형별 [메일,회의록,장애 발생 공지등] 에 따라

어떻게 작성하는게 좋은지에 대한 내용을 다루고 있다.

 

수정전 수정후 의 내용을 보여주어 해당을 바꾸었을때

 

어떤 차이가 있는지를 직접 확인 할 수 있어 좋은듯 하다.

 

개인적으로는

앞부분의 내용이 업무에 필요한 글쓰기에도 좋지만

전문서를 집필할때도 좋은 가이드가 아닌가 하는 생각이 든다.

 

어떤 내용을 효과적으로 전달하기 위해서

어떻게 구성을 해야 하는지에 대한 내용이 주를 이루고 있기에

 

책의 내용이 업무적인 내용을 전달할때 어떻게 글을 써야 하는지에 대한 내용이지만

전문서 같은 지식을 전달하기 위한 책을 집필하려는 분들이 보기에도 괜찮은 책인듯 하다.

 

 

1명이 이 리뷰를 추천합니다. 접어보기
  •  종이책 상품상세 페이지에서 더 많은 리뷰를 확인하실 수 있습니다. 바로가기

한줄평 (3건)

0/50
맨위로