SlideShare a Scribd company logo

(독서광) Docs for Developers 기술 문서 작성 완벽 가이드

Jay Park
Jay Park

오늘자 강의: https://www.youtube.com/watch?v=D-TaZbfrVgU&list=PLdntWJk2tJPJuQctXMbRDdr9TWOsXClm6&index=1&t=10s

1 of 8
Download to read offline
Docs for Developers
기술 문서 작성 완벽 가이드
DocsforDevelopers기술문서작성완벽가이드
한 페이지 요약
• 책 분류
• IT 교양, IT 에세이
• 대상 독자
• 코드와 함께 문서를 작성해야 하는 개발자
• 기술 문서화에 몸담고 있는 테크니컬 라이터
• 기술 블로그나 기술 뉴스 레터를 만드는 분들
• 특징
• 가상의 프로젝트를 토대로 기술 문서를 읽는 독자의 이해부터 문서 배포와 유지
관리까지 전구간을 다루고 있음
• 부록으로 테크니컬 라이터 11인의 인터뷰를 수록(원서에는 없음)
이 책의 목차
개발은 코드 뿐만 아니라 문서가 뒷받침해야 한다
DocsforDevelopers기술문서작성완벽가이드
• CHAPTER 1 독자 이해하기
_Corg.ly 애플리케이션 출시 한달 전
• CHAPTER 2 문서화 계획하기
_Corg.ly 애플리케이션 문서화 계획 만들기
• CHAPTER 3 문서 초안 만들기
_Corg.ly 애플리케이션 첫 번째 초안
• CHAPTER 4 문서 편집하기
_Corg.ly 애플리케이션 콘텐츠 편집하기
• CHAPTER 5 샘플 코드 통합하기
_Corg.ly 애플리케이션 어떻게 작동하는지 보여주기
• CHAPTER 6 시각적 콘텐츠 추가하기
_Corg.ly 애플리케이션 백 마디 말보다…
• CHAPTER 7 문서 배포하기
_Corg.ly 애플리케이션 배포!
• CHAPTER 8 피드백 수집하고 통합하기
_Corg.ly 애플리케이션 첫 번째 피드백
• CHAPTER 9 문서 품질 측정하기
_Corg.ly 애플리케이션 출시 다음 주 화요일
• CHAPTER 10 문서 구조화하기
_Corg.ly 애플리케이션 다음 릴리스
• CHAPTER 11 문서 유지 관리 및 지원 중단하기
_Corg.ly 애플리케이션 몇 번의 릴리스 후
• 부록 A. 국내 테크니컬 라이팅은 어떨까요?
부록 B. 전문가를 고용해야 하는 경우
부록 C. 참고 자료
무엇이 이 책을 흥미롭게 만드는가?(1)
어렵게만 느껴지는 기술 문서 작성을 어떻게 하면 덜 고통스럽게 진행할 것인가?
DocsforDevelopers기술문서작성완벽가이드
• ‘강아지 음성 번역 서비스’를 만드는 개발팀의 스토리가 한 축, 개발 문서 작성 방법이 다른 한 축
• 단계별 예제, 템플릿, 가이드, 그리고 도표와 그림으로 설명
• 전반적인 기술 문서의 라이프 사이클을 모두 다르고 있음 - 문서 작성 뿐만 아니라 배포와 유지까지 고려하고 있음
• 문서 작성 과정에서 소프트웨어의 부족한 점을 파악하고 이를 개발에 반영하는 방법도 소개
• 코드가 아무리 잘 작성되더라도 그 자체로 문서화가 끝나지는 않음 à 설령 개발자라도 맥락을 제대로 파악하지 못하
면 문서로서의 코드는 가치가 하락한다는 사실에 주의해야 함
무엇이 이 책을 흥미롭게 만드는가?(2)
현장감 있는 인터뷰
DocsforDevelopers기술문서작성완벽가이드
• 우아한형제들, LINE Plus, 카카오엔터프라이즈, NHN 클라우드, 넷마블, 데브시스터즈, AWS, 쿠팡에서 활동하는 테크니컬 라
이터 총 출동
• 11명이나 되는 테크니컬 라이터의 인터뷰 내용을 보고 조금 놀랐는데… 글을 쓰는 업에 종사하는 분들이니 당연히 흔쾌히 요
청을 받아줬을 거라는 생각이 들었음…
• 테크니컬 라이팅이 무엇인지, 업계에서 테크니컬 라이터의 역할에 대해 설명
• 각 회사마다 조금씩 다른 특성이 느껴졌고 맡은 문서 유형에 따라 또 다른 접근 방법이 보였기에 테크니컬 라이터의 삶을 이해
하는 과정에 도움이 되리라고 봄
대상 독자
테크니컬 라이터의 세계가 궁금하다면? 이 책을 읽어보시라
DocsforDevelopers기술문서작성완벽가이드
• 기술 문서 작성에 관심이 많은 분들
• 코드와 함께 문서를 작성해야 하는 개발자
• 기술 문서화에 몸담고 있는 테크니컬 라이터
• 기술 블로그나 기술 뉴스 레터를 만드는 분들
• 기술 제안서를 작성해야 하는 분들
• 개발자들이 겪는 (문서화) 문제에 대한 해결책을 어느 정도 제시하므로 개발자들도 읽어보면 도움이 될 것이다!
Ad

Recommended

(독서광) 필독! 개발자 온보딩 가이드
(독서광) 필독! 개발자 온보딩 가이드(독서광) 필독! 개발자 온보딩 가이드
(독서광) 필독! 개발자 온보딩 가이드Jay Park
 
(독서광) 만들면서 배우는 클린 아키텍처
(독서광) 만들면서 배우는 클린 아키텍처(독서광) 만들면서 배우는 클린 아키텍처
(독서광) 만들면서 배우는 클린 아키텍처Jay Park
 
(독서광) 개발자로 첫 출근했어요 - 사내 개발 도구, 기술, 문화 적응 가이드
(독서광) 개발자로 첫 출근했어요 - 사내 개발 도구, 기술, 문화 적응 가이드(독서광) 개발자로 첫 출근했어요 - 사내 개발 도구, 기술, 문화 적응 가이드
(독서광) 개발자로 첫 출근했어요 - 사내 개발 도구, 기술, 문화 적응 가이드Jay Park
 
DDD 그게 뭔데 (개념 찍먹편)
DDD 그게 뭔데 (개념 찍먹편)DDD 그게 뭔데 (개념 찍먹편)
DDD 그게 뭔데 (개념 찍먹편)명석 고
 
(책 소개) 한 권으로 읽는 컴퓨터 구조와 프로그래밍
(책 소개) 한 권으로 읽는 컴퓨터 구조와 프로그래밍(책 소개) 한 권으로 읽는 컴퓨터 구조와 프로그래밍
(책 소개) 한 권으로 읽는 컴퓨터 구조와 프로그래밍Jay Park
 
(독서광) 기획자의 글쓰기
(독서광) 기획자의 글쓰기(독서광) 기획자의 글쓰기
(독서광) 기획자의 글쓰기Jay Park
 
차정민 (소프트웨어 엔지니어) 이력서 + 경력기술서
차정민 (소프트웨어 엔지니어) 이력서 + 경력기술서차정민 (소프트웨어 엔지니어) 이력서 + 경력기술서
차정민 (소프트웨어 엔지니어) 이력서 + 경력기술서Jeongmin Cha
 

More Related Content

Similar to (독서광) Docs for Developers 기술 문서 작성 완벽 가이드

백엔드 개발자로 1인분하기
백엔드 개발자로 1인분하기백엔드 개발자로 1인분하기
백엔드 개발자로 1인분하기민건 주
 
오픈소스 소프트웨어 개발, 어디서부터 시작하는게 좋을까요? @ CNU(충남대)
오픈소스 소프트웨어 개발, 어디서부터 시작하는게 좋을까요? @ CNU(충남대)오픈소스 소프트웨어 개발, 어디서부터 시작하는게 좋을까요? @ CNU(충남대)
오픈소스 소프트웨어 개발, 어디서부터 시작하는게 좋을까요? @ CNU(충남대)Jaewon Choi
 
(독서광) 프로그래머의 뇌
(독서광) 프로그래머의 뇌(독서광) 프로그래머의 뇌
(독서광) 프로그래머의 뇌Jay Park
 
격변하는 프로그래밍 언어, 이제는 Let it go
격변하는 프로그래밍 언어, 이제는 Let it go격변하는 프로그래밍 언어, 이제는 Let it go
격변하는 프로그래밍 언어, 이제는 Let it goChris Ohk
 
이제 문서는 DocC로 만들때가 되지 않았나요?
이제 문서는 DocC로 만들때가  되지 않았나요?이제 문서는 DocC로 만들때가  되지 않았나요?
이제 문서는 DocC로 만들때가 되지 않았나요?hyunho Lee
 
[네이버오픈소스세미나] egjs-view360 개발기 - 김희재
[네이버오픈소스세미나] egjs-view360 개발기 - 김희재[네이버오픈소스세미나] egjs-view360 개발기 - 김희재
[네이버오픈소스세미나] egjs-view360 개발기 - 김희재NAVER D2
 
(책 소개) 가상 면접 사례로 배우는 대규모 시스템 설계 기초
(책 소개) 가상 면접 사례로 배우는 대규모 시스템 설계 기초(책 소개) 가상 면접 사례로 배우는 대규모 시스템 설계 기초
(책 소개) 가상 면접 사례로 배우는 대규모 시스템 설계 기초Jay Park
 
SAYAHAE - 상품평 분석 및 추천 서비스 (자연어 처리)
SAYAHAE - 상품평 분석 및 추천 서비스 (자연어 처리)SAYAHAE - 상품평 분석 및 추천 서비스 (자연어 처리)
SAYAHAE - 상품평 분석 및 추천 서비스 (자연어 처리)Eunchan Lee
 
LinqPad for DevOps
LinqPad for DevOpsLinqPad for DevOps
LinqPad for DevOps성수 이
 
소프트웨어 개발 트랜드 및 MSA (마이크로 서비스 아키텍쳐)의 이해
소프트웨어 개발 트랜드 및 MSA (마이크로 서비스 아키텍쳐)의 이해소프트웨어 개발 트랜드 및 MSA (마이크로 서비스 아키텍쳐)의 이해
소프트웨어 개발 트랜드 및 MSA (마이크로 서비스 아키텍쳐)의 이해Terry Cho
 
도메인주도설계
도메인주도설계도메인주도설계
도메인주도설계Wonjun Hwang
 
(독서광) 클린코드 이제는 파이썬이다
(독서광) 클린코드 이제는 파이썬이다(독서광) 클린코드 이제는 파이썬이다
(독서광) 클린코드 이제는 파이썬이다Jay Park
 
오픈소스 컨트리뷰톤 2020 backend.ai 발표자료
오픈소스 컨트리뷰톤 2020 backend.ai 발표자료오픈소스 컨트리뷰톤 2020 backend.ai 발표자료
오픈소스 컨트리뷰톤 2020 backend.ai 발표자료지원 정
 
삶이편해지는_백엔드_개발자_지식.pdf
삶이편해지는_백엔드_개발자_지식.pdf삶이편해지는_백엔드_개발자_지식.pdf
삶이편해지는_백엔드_개발자_지식.pdfSeung kyoo Park
 
신규 협업도구 사용자 교육(공통 비개발자)
신규 협업도구 사용자 교육(공통 비개발자)신규 협업도구 사용자 교육(공통 비개발자)
신규 협업도구 사용자 교육(공통 비개발자)Byeongsu Kang
 
2019년에 기술 문서를 번역하는 기분
2019년에 기술 문서를 번역하는 기분2019년에 기술 문서를 번역하는 기분
2019년에 기술 문서를 번역하는 기분Hyun-woo Park
 
(독서광) Node.js 백엔드 개발자 되기
(독서광) Node.js 백엔드 개발자 되기(독서광) Node.js 백엔드 개발자 되기
(독서광) Node.js 백엔드 개발자 되기Jay Park
 
전형규, SilvervineUE4Lua: UE4에서 Lua 사용하기, NDC2019
전형규, SilvervineUE4Lua: UE4에서 Lua 사용하기, NDC2019전형규, SilvervineUE4Lua: UE4에서 Lua 사용하기, NDC2019
전형규, SilvervineUE4Lua: UE4에서 Lua 사용하기, NDC2019devCAT Studio, NEXON
 
[D2 COMMUNITY] Open Container Seoul Meetup - 마이크로 서비스 아키텍쳐와 Docker kubernetes
[D2 COMMUNITY] Open Container Seoul Meetup -  마이크로 서비스 아키텍쳐와 Docker kubernetes[D2 COMMUNITY] Open Container Seoul Meetup -  마이크로 서비스 아키텍쳐와 Docker kubernetes
[D2 COMMUNITY] Open Container Seoul Meetup - 마이크로 서비스 아키텍쳐와 Docker kubernetesNAVER D2
 

Similar to (독서광) Docs for Developers 기술 문서 작성 완벽 가이드 (20)

백엔드 개발자로 1인분하기
백엔드 개발자로 1인분하기백엔드 개발자로 1인분하기
백엔드 개발자로 1인분하기
 
오픈소스 소프트웨어 개발, 어디서부터 시작하는게 좋을까요? @ CNU(충남대)
오픈소스 소프트웨어 개발, 어디서부터 시작하는게 좋을까요? @ CNU(충남대)오픈소스 소프트웨어 개발, 어디서부터 시작하는게 좋을까요? @ CNU(충남대)
오픈소스 소프트웨어 개발, 어디서부터 시작하는게 좋을까요? @ CNU(충남대)
 
(독서광) 프로그래머의 뇌
(독서광) 프로그래머의 뇌(독서광) 프로그래머의 뇌
(독서광) 프로그래머의 뇌
 
격변하는 프로그래밍 언어, 이제는 Let it go
격변하는 프로그래밍 언어, 이제는 Let it go격변하는 프로그래밍 언어, 이제는 Let it go
격변하는 프로그래밍 언어, 이제는 Let it go
 
이제 문서는 DocC로 만들때가 되지 않았나요?
이제 문서는 DocC로 만들때가  되지 않았나요?이제 문서는 DocC로 만들때가  되지 않았나요?
이제 문서는 DocC로 만들때가 되지 않았나요?
 
[네이버오픈소스세미나] egjs-view360 개발기 - 김희재
[네이버오픈소스세미나] egjs-view360 개발기 - 김희재[네이버오픈소스세미나] egjs-view360 개발기 - 김희재
[네이버오픈소스세미나] egjs-view360 개발기 - 김희재
 
about Programmer 2018
about Programmer 2018about Programmer 2018
about Programmer 2018
 
(책 소개) 가상 면접 사례로 배우는 대규모 시스템 설계 기초
(책 소개) 가상 면접 사례로 배우는 대규모 시스템 설계 기초(책 소개) 가상 면접 사례로 배우는 대규모 시스템 설계 기초
(책 소개) 가상 면접 사례로 배우는 대규모 시스템 설계 기초
 
SAYAHAE - 상품평 분석 및 추천 서비스 (자연어 처리)
SAYAHAE - 상품평 분석 및 추천 서비스 (자연어 처리)SAYAHAE - 상품평 분석 및 추천 서비스 (자연어 처리)
SAYAHAE - 상품평 분석 및 추천 서비스 (자연어 처리)
 
LinqPad for DevOps
LinqPad for DevOpsLinqPad for DevOps
LinqPad for DevOps
 
소프트웨어 개발 트랜드 및 MSA (마이크로 서비스 아키텍쳐)의 이해
소프트웨어 개발 트랜드 및 MSA (마이크로 서비스 아키텍쳐)의 이해소프트웨어 개발 트랜드 및 MSA (마이크로 서비스 아키텍쳐)의 이해
소프트웨어 개발 트랜드 및 MSA (마이크로 서비스 아키텍쳐)의 이해
 
도메인주도설계
도메인주도설계도메인주도설계
도메인주도설계
 
(독서광) 클린코드 이제는 파이썬이다
(독서광) 클린코드 이제는 파이썬이다(독서광) 클린코드 이제는 파이썬이다
(독서광) 클린코드 이제는 파이썬이다
 
오픈소스 컨트리뷰톤 2020 backend.ai 발표자료
오픈소스 컨트리뷰톤 2020 backend.ai 발표자료오픈소스 컨트리뷰톤 2020 backend.ai 발표자료
오픈소스 컨트리뷰톤 2020 backend.ai 발표자료
 
삶이편해지는_백엔드_개발자_지식.pdf
삶이편해지는_백엔드_개발자_지식.pdf삶이편해지는_백엔드_개발자_지식.pdf
삶이편해지는_백엔드_개발자_지식.pdf
 
신규 협업도구 사용자 교육(공통 비개발자)
신규 협업도구 사용자 교육(공통 비개발자)신규 협업도구 사용자 교육(공통 비개발자)
신규 협업도구 사용자 교육(공통 비개발자)
 
2019년에 기술 문서를 번역하는 기분
2019년에 기술 문서를 번역하는 기분2019년에 기술 문서를 번역하는 기분
2019년에 기술 문서를 번역하는 기분
 
(독서광) Node.js 백엔드 개발자 되기
(독서광) Node.js 백엔드 개발자 되기(독서광) Node.js 백엔드 개발자 되기
(독서광) Node.js 백엔드 개발자 되기
 
전형규, SilvervineUE4Lua: UE4에서 Lua 사용하기, NDC2019
전형규, SilvervineUE4Lua: UE4에서 Lua 사용하기, NDC2019전형규, SilvervineUE4Lua: UE4에서 Lua 사용하기, NDC2019
전형규, SilvervineUE4Lua: UE4에서 Lua 사용하기, NDC2019
 
[D2 COMMUNITY] Open Container Seoul Meetup - 마이크로 서비스 아키텍쳐와 Docker kubernetes
[D2 COMMUNITY] Open Container Seoul Meetup -  마이크로 서비스 아키텍쳐와 Docker kubernetes[D2 COMMUNITY] Open Container Seoul Meetup -  마이크로 서비스 아키텍쳐와 Docker kubernetes
[D2 COMMUNITY] Open Container Seoul Meetup - 마이크로 서비스 아키텍쳐와 Docker kubernetes
 

More from Jay Park

(독서광) 테드 창의 숨 (아홉 가지 단편/중편 SF 과학 소설 모음집)
(독서광) 테드 창의 숨 (아홉 가지 단편/중편 SF 과학 소설 모음집)(독서광) 테드 창의 숨 (아홉 가지 단편/중편 SF 과학 소설 모음집)
(독서광) 테드 창의 숨 (아홉 가지 단편/중편 SF 과학 소설 모음집)Jay Park
 
(독서광) 이제는 이기는 인생을 살고 싶다 - 적을 만들지 않고 단번에 갈등을 풀어내는 백전백승 변호사의 지혜지략
(독서광) 이제는 이기는 인생을 살고 싶다 - 적을 만들지 않고 단번에 갈등을 풀어내는 백전백승 변호사의 지혜지략(독서광) 이제는 이기는 인생을 살고 싶다 - 적을 만들지 않고 단번에 갈등을 풀어내는 백전백승 변호사의 지혜지략
(독서광) 이제는 이기는 인생을 살고 싶다 - 적을 만들지 않고 단번에 갈등을 풀어내는 백전백승 변호사의 지혜지략Jay Park
 
(독서광) 프로덕트 매니저 원칙: 10년이 가도 변하지 않을 PM/PO로 살아가는 원칙과 철학
(독서광) 프로덕트 매니저 원칙: 10년이 가도 변하지 않을 PM/PO로 살아가는 원칙과 철학(독서광) 프로덕트 매니저 원칙: 10년이 가도 변하지 않을 PM/PO로 살아가는 원칙과 철학
(독서광) 프로덕트 매니저 원칙: 10년이 가도 변하지 않을 PM/PO로 살아가는 원칙과 철학Jay Park
 
(독서광) 책 vs 책: 코딩 테스트 합격자 되기 vs 파이썬 알고리즘 인터뷰
(독서광) 책 vs 책: 코딩 테스트 합격자 되기 vs 파이썬 알고리즘 인터뷰(독서광) 책 vs 책: 코딩 테스트 합격자 되기 vs 파이썬 알고리즘 인터뷰
(독서광) 책 vs 책: 코딩 테스트 합격자 되기 vs 파이썬 알고리즘 인터뷰Jay Park
 
(독서광) 테니스 이너 게임
(독서광) 테니스 이너 게임(독서광) 테니스 이너 게임
(독서광) 테니스 이너 게임Jay Park
 
(독서광) 인간 vs. AI 정규표현식 문제 풀이 대결
(독서광) 인간 vs. AI 정규표현식 문제 풀이 대결(독서광) 인간 vs. AI 정규표현식 문제 풀이 대결
(독서광) 인간 vs. AI 정규표현식 문제 풀이 대결Jay Park
 
(독서광) 모던 리눅스 교과서
(독서광) 모던 리눅스 교과서(독서광) 모던 리눅스 교과서
(독서광) 모던 리눅스 교과서Jay Park
 
(독서광) 상자 밖에 있는 사람
(독서광) 상자 밖에 있는 사람(독서광) 상자 밖에 있는 사람
(독서광) 상자 밖에 있는 사람Jay Park
 
(독서광) 자바 알고리즘 인터뷰 with 코틀린
(독서광) 자바 알고리즘 인터뷰 with 코틀린(독서광) 자바 알고리즘 인터뷰 with 코틀린
(독서광) 자바 알고리즘 인터뷰 with 코틀린Jay Park
 
(독서광) 리그 오브 레전드 플레이어 중심주의
(독서광) 리그 오브 레전드 플레이어 중심주의(독서광) 리그 오브 레전드 플레이어 중심주의
(독서광) 리그 오브 레전드 플레이어 중심주의Jay Park
 
(독서광) 오늘날 우리는 컴퓨터라 부른다
(독서광) 오늘날 우리는 컴퓨터라 부른다(독서광) 오늘날 우리는 컴퓨터라 부른다
(독서광) 오늘날 우리는 컴퓨터라 부른다Jay Park
 
(독서광) 사실은 이것도 디자인입니다
(독서광) 사실은 이것도 디자인입니다(독서광) 사실은 이것도 디자인입니다
(독서광) 사실은 이것도 디자인입니다Jay Park
 
(독서광) 프로덕트 매니지먼트
(독서광) 프로덕트 매니지먼트(독서광) 프로덕트 매니지먼트
(독서광) 프로덕트 매니지먼트Jay Park
 
(독서광) 슬기로운 파이썬 트릭
(독서광) 슬기로운 파이썬 트릭(독서광) 슬기로운 파이썬 트릭
(독서광) 슬기로운 파이썬 트릭Jay Park
 
(독서광) 유혹하는 글쓰기
(독서광) 유혹하는 글쓰기(독서광) 유혹하는 글쓰기
(독서광) 유혹하는 글쓰기Jay Park
 
(독서광) 개발자를 넘어 기술 리더로 가는 길
(독서광) 개발자를 넘어 기술 리더로 가는 길(독서광) 개발자를 넘어 기술 리더로 가는 길
(독서광) 개발자를 넘어 기술 리더로 가는 길Jay Park
 
(독서광) 인공지능 소프트웨어 품질 보증을 위한 테스트 기법
(독서광) 인공지능 소프트웨어  품질 보증을 위한 테스트 기법(독서광) 인공지능 소프트웨어  품질 보증을 위한 테스트 기법
(독서광) 인공지능 소프트웨어 품질 보증을 위한 테스트 기법Jay Park
 
(독서광) 싱크 어게인
(독서광) 싱크 어게인(독서광) 싱크 어게인
(독서광) 싱크 어게인Jay Park
 
(독서광) 면역
(독서광) 면역(독서광) 면역
(독서광) 면역Jay Park
 
그림으로 배우는 StatQuest 머신러닝 강의
그림으로 배우는 StatQuest 머신러닝 강의그림으로 배우는 StatQuest 머신러닝 강의
그림으로 배우는 StatQuest 머신러닝 강의Jay Park
 

More from Jay Park (20)

(독서광) 테드 창의 숨 (아홉 가지 단편/중편 SF 과학 소설 모음집)
(독서광) 테드 창의 숨 (아홉 가지 단편/중편 SF 과학 소설 모음집)(독서광) 테드 창의 숨 (아홉 가지 단편/중편 SF 과학 소설 모음집)
(독서광) 테드 창의 숨 (아홉 가지 단편/중편 SF 과학 소설 모음집)
 
(독서광) 이제는 이기는 인생을 살고 싶다 - 적을 만들지 않고 단번에 갈등을 풀어내는 백전백승 변호사의 지혜지략
(독서광) 이제는 이기는 인생을 살고 싶다 - 적을 만들지 않고 단번에 갈등을 풀어내는 백전백승 변호사의 지혜지략(독서광) 이제는 이기는 인생을 살고 싶다 - 적을 만들지 않고 단번에 갈등을 풀어내는 백전백승 변호사의 지혜지략
(독서광) 이제는 이기는 인생을 살고 싶다 - 적을 만들지 않고 단번에 갈등을 풀어내는 백전백승 변호사의 지혜지략
 
(독서광) 프로덕트 매니저 원칙: 10년이 가도 변하지 않을 PM/PO로 살아가는 원칙과 철학
(독서광) 프로덕트 매니저 원칙: 10년이 가도 변하지 않을 PM/PO로 살아가는 원칙과 철학(독서광) 프로덕트 매니저 원칙: 10년이 가도 변하지 않을 PM/PO로 살아가는 원칙과 철학
(독서광) 프로덕트 매니저 원칙: 10년이 가도 변하지 않을 PM/PO로 살아가는 원칙과 철학
 
(독서광) 책 vs 책: 코딩 테스트 합격자 되기 vs 파이썬 알고리즘 인터뷰
(독서광) 책 vs 책: 코딩 테스트 합격자 되기 vs 파이썬 알고리즘 인터뷰(독서광) 책 vs 책: 코딩 테스트 합격자 되기 vs 파이썬 알고리즘 인터뷰
(독서광) 책 vs 책: 코딩 테스트 합격자 되기 vs 파이썬 알고리즘 인터뷰
 
(독서광) 테니스 이너 게임
(독서광) 테니스 이너 게임(독서광) 테니스 이너 게임
(독서광) 테니스 이너 게임
 
(독서광) 인간 vs. AI 정규표현식 문제 풀이 대결
(독서광) 인간 vs. AI 정규표현식 문제 풀이 대결(독서광) 인간 vs. AI 정규표현식 문제 풀이 대결
(독서광) 인간 vs. AI 정규표현식 문제 풀이 대결
 
(독서광) 모던 리눅스 교과서
(독서광) 모던 리눅스 교과서(독서광) 모던 리눅스 교과서
(독서광) 모던 리눅스 교과서
 
(독서광) 상자 밖에 있는 사람
(독서광) 상자 밖에 있는 사람(독서광) 상자 밖에 있는 사람
(독서광) 상자 밖에 있는 사람
 
(독서광) 자바 알고리즘 인터뷰 with 코틀린
(독서광) 자바 알고리즘 인터뷰 with 코틀린(독서광) 자바 알고리즘 인터뷰 with 코틀린
(독서광) 자바 알고리즘 인터뷰 with 코틀린
 
(독서광) 리그 오브 레전드 플레이어 중심주의
(독서광) 리그 오브 레전드 플레이어 중심주의(독서광) 리그 오브 레전드 플레이어 중심주의
(독서광) 리그 오브 레전드 플레이어 중심주의
 
(독서광) 오늘날 우리는 컴퓨터라 부른다
(독서광) 오늘날 우리는 컴퓨터라 부른다(독서광) 오늘날 우리는 컴퓨터라 부른다
(독서광) 오늘날 우리는 컴퓨터라 부른다
 
(독서광) 사실은 이것도 디자인입니다
(독서광) 사실은 이것도 디자인입니다(독서광) 사실은 이것도 디자인입니다
(독서광) 사실은 이것도 디자인입니다
 
(독서광) 프로덕트 매니지먼트
(독서광) 프로덕트 매니지먼트(독서광) 프로덕트 매니지먼트
(독서광) 프로덕트 매니지먼트
 
(독서광) 슬기로운 파이썬 트릭
(독서광) 슬기로운 파이썬 트릭(독서광) 슬기로운 파이썬 트릭
(독서광) 슬기로운 파이썬 트릭
 
(독서광) 유혹하는 글쓰기
(독서광) 유혹하는 글쓰기(독서광) 유혹하는 글쓰기
(독서광) 유혹하는 글쓰기
 
(독서광) 개발자를 넘어 기술 리더로 가는 길
(독서광) 개발자를 넘어 기술 리더로 가는 길(독서광) 개발자를 넘어 기술 리더로 가는 길
(독서광) 개발자를 넘어 기술 리더로 가는 길
 
(독서광) 인공지능 소프트웨어 품질 보증을 위한 테스트 기법
(독서광) 인공지능 소프트웨어  품질 보증을 위한 테스트 기법(독서광) 인공지능 소프트웨어  품질 보증을 위한 테스트 기법
(독서광) 인공지능 소프트웨어 품질 보증을 위한 테스트 기법
 
(독서광) 싱크 어게인
(독서광) 싱크 어게인(독서광) 싱크 어게인
(독서광) 싱크 어게인
 
(독서광) 면역
(독서광) 면역(독서광) 면역
(독서광) 면역
 
그림으로 배우는 StatQuest 머신러닝 강의
그림으로 배우는 StatQuest 머신러닝 강의그림으로 배우는 StatQuest 머신러닝 강의
그림으로 배우는 StatQuest 머신러닝 강의
 

(독서광) Docs for Developers 기술 문서 작성 완벽 가이드

  • 1. Docs for Developers 기술 문서 작성 완벽 가이드
  • 2. DocsforDevelopers기술문서작성완벽가이드 한 페이지 요약 • 책 분류 • IT 교양, IT 에세이 • 대상 독자 • 코드와 함께 문서를 작성해야 하는 개발자 • 기술 문서화에 몸담고 있는 테크니컬 라이터 • 기술 블로그나 기술 뉴스 레터를 만드는 분들 • 특징 • 가상의 프로젝트를 토대로 기술 문서를 읽는 독자의 이해부터 문서 배포와 유지 관리까지 전구간을 다루고 있음 • 부록으로 테크니컬 라이터 11인의 인터뷰를 수록(원서에는 없음)
  • 3. 이 책의 목차 개발은 코드 뿐만 아니라 문서가 뒷받침해야 한다 DocsforDevelopers기술문서작성완벽가이드 • CHAPTER 1 독자 이해하기 _Corg.ly 애플리케이션 출시 한달 전 • CHAPTER 2 문서화 계획하기 _Corg.ly 애플리케이션 문서화 계획 만들기 • CHAPTER 3 문서 초안 만들기 _Corg.ly 애플리케이션 첫 번째 초안 • CHAPTER 4 문서 편집하기 _Corg.ly 애플리케이션 콘텐츠 편집하기 • CHAPTER 5 샘플 코드 통합하기 _Corg.ly 애플리케이션 어떻게 작동하는지 보여주기 • CHAPTER 6 시각적 콘텐츠 추가하기 _Corg.ly 애플리케이션 백 마디 말보다… • CHAPTER 7 문서 배포하기 _Corg.ly 애플리케이션 배포! • CHAPTER 8 피드백 수집하고 통합하기 _Corg.ly 애플리케이션 첫 번째 피드백 • CHAPTER 9 문서 품질 측정하기 _Corg.ly 애플리케이션 출시 다음 주 화요일 • CHAPTER 10 문서 구조화하기 _Corg.ly 애플리케이션 다음 릴리스 • CHAPTER 11 문서 유지 관리 및 지원 중단하기 _Corg.ly 애플리케이션 몇 번의 릴리스 후 • 부록 A. 국내 테크니컬 라이팅은 어떨까요? 부록 B. 전문가를 고용해야 하는 경우 부록 C. 참고 자료
  • 4. 무엇이 이 책을 흥미롭게 만드는가?(1) 어렵게만 느껴지는 기술 문서 작성을 어떻게 하면 덜 고통스럽게 진행할 것인가? DocsforDevelopers기술문서작성완벽가이드 • ‘강아지 음성 번역 서비스’를 만드는 개발팀의 스토리가 한 축, 개발 문서 작성 방법이 다른 한 축 • 단계별 예제, 템플릿, 가이드, 그리고 도표와 그림으로 설명 • 전반적인 기술 문서의 라이프 사이클을 모두 다르고 있음 - 문서 작성 뿐만 아니라 배포와 유지까지 고려하고 있음 • 문서 작성 과정에서 소프트웨어의 부족한 점을 파악하고 이를 개발에 반영하는 방법도 소개 • 코드가 아무리 잘 작성되더라도 그 자체로 문서화가 끝나지는 않음 à 설령 개발자라도 맥락을 제대로 파악하지 못하 면 문서로서의 코드는 가치가 하락한다는 사실에 주의해야 함
  • 5. 무엇이 이 책을 흥미롭게 만드는가?(2) 현장감 있는 인터뷰 DocsforDevelopers기술문서작성완벽가이드 • 우아한형제들, LINE Plus, 카카오엔터프라이즈, NHN 클라우드, 넷마블, 데브시스터즈, AWS, 쿠팡에서 활동하는 테크니컬 라 이터 총 출동 • 11명이나 되는 테크니컬 라이터의 인터뷰 내용을 보고 조금 놀랐는데… 글을 쓰는 업에 종사하는 분들이니 당연히 흔쾌히 요 청을 받아줬을 거라는 생각이 들었음… • 테크니컬 라이팅이 무엇인지, 업계에서 테크니컬 라이터의 역할에 대해 설명 • 각 회사마다 조금씩 다른 특성이 느껴졌고 맡은 문서 유형에 따라 또 다른 접근 방법이 보였기에 테크니컬 라이터의 삶을 이해 하는 과정에 도움이 되리라고 봄
  • 6. 대상 독자 테크니컬 라이터의 세계가 궁금하다면? 이 책을 읽어보시라 DocsforDevelopers기술문서작성완벽가이드 • 기술 문서 작성에 관심이 많은 분들 • 코드와 함께 문서를 작성해야 하는 개발자 • 기술 문서화에 몸담고 있는 테크니컬 라이터 • 기술 블로그나 기술 뉴스 레터를 만드는 분들 • 기술 제안서를 작성해야 하는 분들 • 개발자들이 겪는 (문서화) 문제에 대한 해결책을 어느 정도 제시하므로 개발자들도 읽어보면 도움이 될 것이다!
  • 7. 결론 **** 문서 작성도 소프트웨어 개발의 일부다 • 이 책은 특정 도구나 프레임워크나 복잡한 방법론을 설명하지 않는다 à 문서화에 가장 효과적인 도구는 개발 환경과 맞물려 있기 때문 • 대신 기술 문서를 처음부터 만드는 과정을 차례로 안내하면서 무엇이 중요한지 맥을 짚는 방식을 사용한다 à 어떻게 보면 너무나 당연하고 일반적인 이야기처럼 들리지만 실제로 고려해야 할 사항은 많다! • 대상 독자 파악 • 사용자 요구 사항 파악 • 문서화 패턴에 맞춰 계획 수립 • 콘텐츠 초안을 작성하고 편집 • 여러 미디어로 배포 • 사용자 피드백을 취합하고 문서의 유효성을 측정하고 유지 관리 작업을 수행 DocsforDevelopers기술문서작성완벽가이드
  • 8. 발표자 소개 기술 배경 전문 검색 엔진, 임베디드 시스템(리눅스 커널 디바이스 드라이버), 빅데이터/인공지능 연구 개발, 고성능 고가용성 데이터베이스 주요활동 IT 전문서 번역 (클린 코드, 피플웨어, 해커: 광기의 랩소디, 게임 엔진 블랙 북 등) 개발강의 (삼성전자, SK C&C, 삼성SDC, 현대자동차 기술 세미나와 교육) 활동채널 블로그: https://jhrogue.blogspot.com 슬라이드 셰어: https://www.slideshare.net/jrogue/presentations 유튜브: https://www.youtube.com/c/박재호dev 문의 jrogue@gmail.com 박재호