상세정보
미리보기
개발자는 글을 못 쓴다고요? : 커밋 메시지부터 리드미, 릴리스 노트, 장애 보고서, 기술 블로그, ChatGPT 활용까지 개발자를 위한 글쓰기 실전 가이드
- 저자
- 황수정,전정은 저
- 출판사
- 제이펍
- 출판일
- 2025-12-11
- 등록일
- 2026-01-28
- 파일포맷
- PDF
- 파일크기
- 17MB
- 공급사
- 예스이십사
- 지원기기
-
PC
PHONE
TABLET
웹뷰어
프로그램 수동설치
뷰어프로그램 설치 안내
책소개
문서는 실력이고, 글은 또 하나의 코드입니다 개발자는 오늘도 글을 씁니다. 커밋 메시지부터 리드미, 릴리스 노트, 기술 블로그까지 일의 많은 순간에 글이 필요합니다. 이 책은 그런 글을 더 잘 쓰고 싶은 개발자를 위한 실전 가이드입니다. 주석, 예제 코드, 시작하기 문서처럼 자주 마주치는 글쓰기부터 정확하고 간결한 기술 문서 작성법, 이메일과 메시지, ChatGPT 활용 팁까지 실무에 꼭 맞는 내용으로 구성했습니다. 글이 쌓이면 문서가 되고 문서는 곧 실력이 됩니다. 글 앞에서 자주 멈칫하는 개발자에게 이 책이 글쓰기 실력을 키우는 든든한 첫걸음이 되어줄 것입니다.
저자소개
LINE PLUS에서 글 읽고, 글 쓰고, 글 더하고, 글 빼고, 글 다듬고, 글 심고, 글 뽑고, 글 빚고, 글 굽고, 글 꿰어서 개발자와 개발자를 잇는 일을 하고 있다.
목차
추천의 글 12베타리더 후기 18여는 글 20PART I 개발자는 정말 글을 못 쓸까?1 개발자는 코드로 소통한다? 272 반복, 또 반복 293 글에는 목적이 있다 314 번역서 참고는 그만 34PART II 글을 잘 쓰는 개발자는 코드부터 다르다5 커밋 메시지 작성하기 41커밋 메시지를 잘 써야 하는 이유 43커밋을 설계하세요 46[쉬어가기] 커밋 메시지 해부학 47커밋 메시지 제목 쓰기 49커밋 메시지 본문 쓰기 64커밋 메시지 작성해보기 68커밋 메시지 맛집 706 개발자는 작명가 72함수에 걸맞은 이름 짓기 74함수 이름 짓기 연습 847 오류 메시지 쓰기 100오류 메시지 구성 요소 101오류 메시지를 봤는데 무슨 말인지 모르겠다 103어떻게 해결해야 하는지 모르겠다 107오류 메시지에 있는 안내대로 했는데 해결이 안 된다 109해결 방법을 어디서 찾아야 하는지 모르겠다 109[쉬어가기] 금과 은 나 없어도 내게 있는 것 네게 주니 1108 API 주석 111API 주석 형식 116API 설명 기본 규칙 118실전 연습 124설명문 형식 정하기 128[쉬어가기] API 설명은 영어여야만 할까요? 130OpenAPI 명세로 쓰기 131도구를 너무 믿지 말자 133[쉬어가기] 미래의 나를 위해서라도 꼭 쓰세요! 134PART III 개발자의 글은 곧 PR이다9 리드미 139나를 읽어주세요 142리드미에 써야 할 정보는? 143실전 리드미 작성 148[쉬어가기] 모두가 아는 정보 판단법 153이왕이면 다홍치마 154템플릿, 널 위해 준비했어 15710 예시 코드 159예시 코드가 있어야 할 곳 160소스 코드 말고 예시를 161소스 코드를 예시로 만드는 주문 168[쉬어가기] 예시 코드에서 내부 정보 감추기 172샘플 프로그램 173[쉬어가기] cURL 예시도 REST API 예시 코드일까요? 175작동하지 않으면 코드가 아니다 17711 장애 보고서 179[쉬어가기] 서비스가 멈추는 순간, 우리가 겪는 불편함 181장애 보고서란? 181장애 보고서엔 무엇을 쓰나요? 183장애 보고서는 누가 쓰나요? 192장애 보고서는 언제 쓰나요? 193장애 보고서는 어디에 쓰나요? 19512 릴리스 노트 206릴리스 노트? 체인지 로그? 207[쉬어가기] 반박 시 당신 말씀이 맞습니다만, 저도 맞을 수 있지 않을까요? 210릴리스 노트를 알아봅시다 211[쉬어가기] 끝날 때까진 끝난 것이 아니다! deprecated는 아직이에요 213[쉬어가기] 릴리스 노트가 길어지면 어쩌죠? 221[쉬어가기] 문서도 릴리스 노트를 써야 할까요? 228체인지 로그를 알아봅시다 229[쉬어가기] 해당하는 정보가 없을 땐 없다고 명시하세요 23413 시작하기 문서 236시작하기의 도입부: 가입과 설치 238시작하기의 핵심: 기본 기능 수행 240시작하기의 마무리 243문제점 찾기 연습 24614 기술 블로그 253무엇을 얻고 싶은가요? 254블로그, 기본 틀 257블로그, 어떤 글을 쓸까요? 268[쉬어가기] 글로 영업해보세요 270블로그, 쓸 때 생각해볼 것 276[쉬어가기] 소화할 수 있는 글쓰기 277블로그, 시작해봅시다 283블로그, 어렵죠? 289PART IV 기술 글쓰기에는 기법이 있다15 정확성 295정확한 용어 사용하기 298[쉬어가기] 실무에서 쓰는 표현 기술 문서에 알맞게 포장하기 305명령문과 평서문 307명령문과 평서문 둘 다 표현할 수 있을 때는? 316[쉬어가기] 쉴 수 있을 때 쉬어야 하니 쉬세요! 317최신 정보 반영하기 31716 간결성 326두괄식으로 쓰기 328목록과 표 335[쉬어가기] 점 목록만으로 쓴 문서는 정말 읽기 쉬울까요? 341[쉬어가기] 귀찮지만 포기할 수 없는 셀 병합 345다이어그램 34817 완결성 363도입부 쓰기 364[쉬어가기] 용어 설명은 짧은 팝업으로 출력해보세요 371[쉬어가기] 형식과 기법보다는 내용과 목적이 중요합니다 374일단 쓰고 지우기 374우리말로 글쓰기 387[쉬어가기] 지금 무슨 말을 하고 있는지 아나요? 389[쉬어가기] 우리말, 우리글로도 할 수 있어요 396APPENDIX 메시지도, AI 도구도 글쓰기에서 시작된다A 이메일이나 메시지 쓰기 403이메일 또는 남겨둘 메시지 쓰기 404지시하고 응답하기 406문제 상황 보고하기 408B ChatGPT 활용하기 411네가 해줘 말고 도와줘 411API 주석 쓰기 413규칙 검사하기 419도판 출처 426
![게임 개발자가 알려주는 유니티 게임 제작 입문 [개정판]](https://image.yes24.com/goods/165279035/L)