원제는 "Technical Writing for Developers: Utilizing HTML, JavaScript, Markdown, and GitHub for Writing"라는 긴 제목입니다. 제목에 목차를 다 담고 있네요. 하지만 내용은 개발자를 위한 테크니컬 라이팅이라기보다는 테크니컬 라이터를 위한 기본 지식 정도가 적당하지 않을까 싶네요.
https://www.amazon.com/Technical-Writing-Developers-Utilizing-JavaScript/dp/B0FPF7VB81
Apress 출판사의 포켓 가이드 시리즈로 출판되었고, 딱 손에 들어오는 작은 크기의 책입니다. 2026년 1월 출판된 책이구요.
1장부터 6장까지는 기본적인 HTML, CSS, 자바스크립트 문법을 다룹니다. 이런 식으로 문서를 만들 수 있어 정도의 지식까지만 다룹니다. 7장과 8장은 마크다운을 소개하는데, 앞에서 배운 HTML과 차이점을 이해하면서 기본적인 문법을 익히도록 합니다. 그리고 9장에서는 GitHub를 다룹니다. 보통 많은 기술 서적에서 GitHub보다는 Git을 다루는데, 이 책은 그냥 GitHub 사이트에서 직접 문서를 생성하고 버전을 관리하는 방법을 보여줍니다. 10장은 마무리구요.
이런 내용을 누가 보겠어~라고 생각하겠지만, 여전히 워드로 문서를 생성하는 테크니컬 라이터가 많고, 이런 이들에게 웹 기반 문서로 전환하는 것은 쉽지 않습니다. 이 책은 그런 사용자를 위해(그런데 왜 책 제목을) 아주 기본적인 내용을 알려주고 있습니다.
저자인 Jim Hall은 독특한 커리어를 가지고 있습니다. 꽤 오랜 기간 동안 대학에서 전산 관리자로 일하면서 다양한 오픈소스 프로젝트에 참여했습니다. 그리고 최근에는 Hallmentum라는 회사를 운영하고 있는데, IT 기업 리더들을 코칭하고 다양한 워크숍 프로그램을 운영합니다. 커리어만 보면 딱히 테크니컬 라이터로서의 경력은 없는데 https://technicallywewrite.com/ 라는 사이트를 운영하고 있습니다. 최근에 올린 글이 "Master documents make it easy"라는 글인데, 저자 본인은 문서 작성 시 주로 LibreOffice를 사용한다고 하네요.
좀 더 상세하게 살펴보면
1장은 Hello World 수준으로 HTML을 다룹니다. <samp> 태그나 <kbd> 태그를 설명하는 것은 좀 당황스럽긴 한데 일단 테크니컬 라이팅에 대한 내용이니, 뭔가 출력되는 결과에 대한 설명이 필요할 것이라고 판단했는지 모르겠네요. 4장과 6장 코드에서 실제로 사용하기도 합니다.
2장은 접근성, 시맨틱 마크업에 대한 내용입니다. 1장에서 Hello World 찍고 바로 넘어가기에는 좀 부담스러울지도 모르겠는데, 깊이 들어가지는 않고 가볍게 다루고 넘어갑니다.
3장은 CSS를 정말 아주 가볍게 다룹니다. CSS 코드가 C 프로그래밍 언어에서 영감을 받았다는 말로 혼란스럽게 하지만, 이 부분은 그냥 무시하고 넘어가도 될 듯합니다. 아마 제목이 개발자를 위한~ 이니깐 C 정도는 해보았지 하는 느낌이 아닐까 싶습니다. 아. 그러고 보니 이 책은 HTML을 접해보지 못한 C 개발자를 위한 책이 될 수도 있겠네요.
4장은 간단한 문서를 만들어봅니다. samp, kbd 태그를 사용해서 좀 복잡하긴 합니다만...
5장은 HTML 문서를 만들고 CSS를 적용하는 것까지 따라가 보는 예제입니다.
6장은 제목은 자바스크립트를 사용해 동적인 문서 만들기인데, 실제는 자바스크립트로 스타일을 적용하는 방식에 대한 설명입니다. 아. 버튼을 클릭할 때마다 버튼의 display 스타일을 바꾸는 기능도 들어가는데 이것도 역시 스타일에 대한 내용이니깐...
7장은 마크다운에 대한 설명입니다. 뒤에서 GitHub를 설명할 것이니 마크다운 파일을 HTML로 변환하는 작업까지 소개할 필요는 없을 것 같은데 pandoc 명령을 사용해 마크다운을 변환하는 방법까지 같이 소개합니다. 물론 마크다운과 HTML이 서로 어떻게 연결되는지 알려주는 좋은 방법이긴 하지만 마크다운을 처음 배우는 이들에게는 좀 어려운 내용이네요.
혹시나 책을 읽게 되면 pandoc을 설치해도 되지만 https://pandoc.org/try/ 같은 사이트에서 확인해 볼 수도 있습니다.
8장은 마크다운 문법을 좀 더 상세하게 다룹니다.
9장은 친절하게 버전 관리의 개요를 먼저 다루고 GitHub에서 파일을 만들고 버전을 관리하는 방법을 다룹니다. 9장만 따로 떼어서 볼 수 있다면 테크니컬 라이터를 위한 정말 좋은 버전 관리 콘텐츠가 될 것 같네요.
10장에서는 문서 관리 도구를 사용하면 HTML이나 마크다운 같은 것은 몰라도 되는 거 아닌가 라는 질문에 대한 답입니다. 도구를 사용해 자동으로 문서를 만들 수 있지만, 문제가 생기거나 원하는 형태가 아닐 때 이를 수정할 수 있어야 한다는 거죠(음, 이건 좀 애매한 게 문서의 일관성이라는 측면에서는 개별적인 문서를 수정하는 것은 바람직한 것은 아니라서). 그리고 AsciiDoc이나 DocBook, DITA에 대해 가볍게 언급만 하고 마무리합니다.
