도서 ‘Docs for Developers 기술 문서 작성 완벽 가이드‘ 리뷰

Docs for Developers 기술 문서 작성 완벽 가이드 - 우아한형제들 카카오 등 국내 테크니컬 라이터 11인 인터뷰 특별 수록
자레드 바티 외 지음, 하성창 옮김 / 한빛미디어 / 2023년 4월

개발자 그룹에서 문서를 쓴다고 하면 보통 '기획자'의 일이라고 치부하기 쉽다. 하지만 기획자가 아니라도 생각보다 '문서'를 쓸 일은 빈번하게 발생한다. 뭐 기획자라고 모두 글을 잘 쓰고 문서를 잘 만드는 것은 아니다. 우리는 모두 '독자'가 누군지를 두고 문서를 써야 하고, 독자는 '지금 하고 있는 것을 자주 안 해서 그때 다시 하려니 전혀 기억이 안 나는' 미래의 나일 수도 있고, '내가 지금 하고 있는 일을 인계받아서 이어서 진행하게 될' 미래의 부사수일 수도 있다. 또는 '내가 개발한 소프트웨어가 제대로 작동하는지 테스트해줄' 테스터 일 수도 있고. 

도서 'Docs for Developers'. '기술 문서 작성 완벽 가이드'는 문서랑은 담을 쌓고 지낼 개발자에게 이름 그대로 완벽한 가이드가 되어 줄 책이다. ​

이 책을 통해 자신의 경험과 노하우를 전해 준 테크니컬 라이터 한 명이 말하길, 기술 문서의 작성 목적은 서로 다른 기술 스택을 보유한 개발자 모두가 협업의 본질을 이해하고, 해당 업무가 처음이더라도 원활하게 일할 수 있는 훌륭한 가이드나 매뉴얼을 남기는 것이라고 했다. 실제로 나는 주로 프로젝트에 새로운 담당 기획자가 오더라도 바로 실무에 적응할 수 있게, 가이드 문서나 매뉴얼 작업을 수시로 하고 최신화를 하고 있다. 물론 안타깝게도 이건 내 이야기이고 보통은 자신이 너무나 익숙하게 담당하고 있는 일들이라 별도의 매뉴얼이나 가이드를 만들 생각을 하지 않는다. 일할 시간도 부족한데 시간을 쪼개서 문서까지 만들기는 번거롭고 우선순위에서 밀리니까.

하지만 잘 만든 가이드 문서는 이후에 번거롭게 '교육'이라는 명목으로 업무를 가르칠 필요를 줄여주고, 담당자가 바뀌거나 내가 부득이하게 부재하게 되더라도 다른 사람이 원활하게 그 자리에 적응할 수 있게 해준다. 이 맛에 매뉴얼을 만든다. (나 없으면 회사가 안 돌아간다는 것은 어디까지나 직원의 착각일 뿐이고, 실제로는 거의 그렇지 않다.)

나는 라이브 서비스의 기획자다. 반복적으로 진행되는 업무들이 많은데 그 텀이 주 단위일 때도 있고 월 단위 일 때도 있고 때론 연 단위일 때도 있다. 6개월 이상으로 터울이 벌어지면 다시 그 업무를 해야 할 때가 되었을 때, 뭐부터 해야 하더라 멍~ 하게 될 때가 있다. 그래서 나는 업무툴의 매뉴얼부터 시작해서 업데이트 프로세스를 문서로 작성하고 그걸 템플릿 화해서 업무에 적용했다. 매달 반복되는 업무에 누락되는 부분이 없고 라이브 서비스에서 오류가 생기는 일도 거의 없게 되었다. 무엇보다 좋았던 부분은 이 템플릿을 다른 프로젝트에 적용할 수 있었고, 프로젝트 담당자가 바뀌었을 때 신규 담당자도 템플릿과 매뉴얼, 가이드를 통해 보다 빠르게 업무에 적응할 수 있었다.

혹자는 내가 매뉴얼과 가이드 문서를 작성하라고 했을 때, 업무할 시간도 없는데 번거롭게 왜 그런 일까지 해야 하는가라고 반문했지만, 시간이 지나 결과를 보면 복잡도가 요구되는 업데이트에서 가이드 문서가 있는 것과 없는 것은 라이브 결과에 큰 영향을 미친다. (예를 들면 라이브되면 안 되는 아이템이 실수로 라이브 되거나, 아이템이나 스킬 수치가 잘못 패치 된다거나, 리소스가 누락된다거나 하는 것 들 말이다.)

그뿐인가.

기획자가 아니더라도, 프로그래머도 본인이 분석 및 R&D 한 결과를 말로만 전달할 수는 없다. 간단한 것은 물론 가능하겠다만, 문서로써 기록을 남기고 그 문서를 보는 독자(예를 들면 기획자라든가)가 이해할 수 있고 재활용할 수 있는 지식을 남겨두면, 후에 같은 일을 또 하게 되는 일도 막을 수 있고 다른 누군가가 그것에 대해 물어보았을 때 잘 정리된 문서의 링크를 전달해 주면 그만인 것이다.​

생각하기에 따라 번거롭지만 업무 효율과 사후 관리를 매우 편하게 하는 기술 문서 작성. 그리고 이 책은 문서랑은 도통 친하지 않은 개발자들에게 의미 있고 가치 있고 전달력 있는 문서를 작성하는 방법을 알려준다.​

그 예전에 어디 컨퍼런스 강의에서 '프로그래머에게 사랑받는 기획서 작성 방법' 뭐 이 비슷한 내용이 있었는데, 기획자도 봐두면 아주 도움이 되는 책이다.​

이 책은 'Corg.ly'라는 가상의 프로젝트를 통해 출시 전부터 출시 후까지를 다루며 개발 문서를 어떻게 작성해 나가는지 챕터별로 그 과정을 다룬다. 활용하기에 따라 정말 다양하게 응용이 가능한 내용으로 개인적으로는 신입 기획자한테도 추천하고 싶은 책이다. 사업팀 신입이 봐도 좋을 것 같다. 어떻게 이런 책이 이제야 나온 것일까. ​

책을 읽고 나서 회사에 두고 신입들 보게 하려고 회사에 구매 요청도 해뒀다.ㅋㅋㅋㅋ

한빛미디어 <나는 리뷰어다> 활동을 위해서 책을 제공받아 작성된 서평입니다.

도서 ‘전문가를 위한 C++‘ 리뷰

전문가를 위한 C++ - C++20, 병렬 알고리즘, 파일시스템, 제네릭 람다, 디자인 패턴, 객체지향의 원리를 익히는 확실한 방법, 개정5판
마크 그레고리 지음, 남기혁 옮김 / 한빛미디어 / 2023년 3월

한빛미디어에서 '전문가를 위한 C++' 개정판이 나왔다. 책의 제목부터도 '전문가'를 위한 책이라고 말하고 있지만, 그 압도적인 두께와 분량을 보고서도 초보자는 집어 들 엄두조차 내지 못할 압도적인 분위기를 풍긴다. 

페이지 수를 대충 보고 넘겼는데 실물 책을 받아드니 엄청난 두께에 놀랍기도 했지만, 이 두꺼운 책에 얼마나 방대한 내용들이 채워져 있을지 기대되기도 한다.

비교를 위해 100원짜리 동전을 옆에 세워 두고 찍어 보았다. 책 펼치고 읽을 때 책등 접히는 거 싫어하는데, 이 책은 책등 접히는 걸 피할 수 없는 운명일 것 같다.

책 제목 처럼 매우 정직하게 이 책은 초보자를 위한 책이 아니라 C++ 기술을 전문가 수준으로 끌어올리고자 하는 프로그래머와 개발자를 위한 책이다. 기본 C++에 대한 약간의 지식이나 C 또는 Java에 대한 상당한 경험, 프로그래밍 기초 및 컴파일러에 대한 친숙함에 대한 견고한 기초가 필요하다. 물론 초보자가 봐도 상관은 없지만 필요한 부분을 찾아 보기에 초보 서적 보다 시간이 많이 걸려 효율은 좋지 않다. 물론 영원한 초보자는 없기에 처음 부터 한 권으로 공부하는 것도 나쁘진 않을 것 같지만... 

C++의 백과사전과도 같은 이 책은 c++의 모든 내용을 다루고 있지만 그중에서도 주요 내용을 뽑으면 아래와 같다.

- 다양한 프로그래밍 방법론과 고품질 프로그래밍 스타일

- 대규모 소프트웨어 개발에 C++를 활용하는 방법

- 버그 없는 코드를 보장하는 방법

- 객체 지향 설계에 대한 감사

- 더 적은 작업으로 더 나은 코드를 작성하기 위해 라이브러리와 패턴을 사용하는 방법

- C++에서 메모리를 관리하는 가장 좋은 방법

이 책을 처음 보는 사람들도 아마 대부분 'Effective C++' 이란 책은 들어 본 적이 있거나 읽어 본 적이 있을 것이다. 그래서 둘을 비교 하자면 'Effective C++'이 주로 효과 적이고 효율적인 코드를 작성하는 방법이나 사례에 중점을 둔 책이라면, 전문가를 위한 C++은  문법 부터 객체 지향 프로그래밍, 템플릿 메타 프로그래밍, 동시성 및 최적화를 포함한 보다 광범위한 내용을 소개 하고 있다.

 프로그래밍의 대한 정보를 그동안 인터넷 검색을 통하여 또는 주변 다른 프로그래머를 통하여 접하면서, 왜? 라는 의문을 가졌던 적이 있었다면 이 책을 추천한다. 분명히 많은 도움이 될 것이다.

도서 ‘이것이 리눅스다‘ 리뷰

이것이 리눅스다 with Rocky Linux9 - 실무와 유사한 가상머신 환경에서 배우는 리눅스 서버, 3판 ㅣ 이것이 시리즈
우재남 지음 / 한빛미디어 / 2023년 2월

오늘 리뷰할 책은 두툼한 두께가 베개로 쓰기에도 좋을 듯한 책, '이것이 리눅스다(그것도 무려 3판임)'이다.

보통 책 옆면 사진도 같이 보여주는데, 이 책 두께를 보면 책을 읽기도 전에 내가 이걸 다 읽을 수 있을까 싶을 정도로 두꺼우니까 옆면은 생략한다. 그래도 같은 값에 이정도 두께면 뭔가 좀 더 내용이 많아 보이니 개이득인 기분도 있다.​

이 책에 대해서 관심이 있는 분들은 아마 리눅스에 대해서 공부를 하고 있거나, 리눅스를 사용하고 있는 초보자 분들이 것이다. (나는 사용을 하고 있는 쪽)

아 그리고 리눅스를 공부하려면 리눅스 설치를 위한 컴퓨터를 새로 구입해야 하나 하는 걱정을 바로 해결해 주는 게 가상 머신으로 리눅스를 설치해서 사용하는 방식이다. 아마 듣기론 실무에서도 실제로 리눅스를 가상 머신으로 설치해서 사용한다고 한다.​

로드맵만 보아도 아주 든든한 마음이 든다. 각각 목차에서 설명할 내용들을 순서대로 따라 가기만 하면 초보자도 리눅스 환경을 세팅하는데 무리가 없다.

내 컴퓨터 한 대를 마치 5대 처럼 사용하는 것이다. 가상 컴퓨터 설치하는 방법이랑 가상 컴퓨터 끼리 연결하는 방법도 매우 자세하게 설명이 되어있다.

이 책에서 사용하는 리눅스는 로키 리눅스인데 첨들어 보는 리눅스 이름이라 먼가 했더니, CentOS 후속 버전이라 생각하면 편하겠다.

이 책을 읽게 된 이유는 단순히 리눅스를 사용하고 싶었고 기본적인 명령어와 윈도우에서 하는 작업들 중에서 리눅스에서 해야 될 작업이 있어서였다.

하지만 책 내용은 기대 이상으로 좋았다. 단순히 VMware를 설치하는 내용만 하더라도 지금 까지 어느 인터넷 사이트에서 본 것보다 자세하게 나와있어 VMware 설치 교본으로 써도 좋을 정도다.

뿐만 아니라 리눅스를 사용하여 윈도를 대체해서 사용할 수 있도록 리눅스용 무료 오피스 프로그램 동영상 재생 프로그램 등 리눅스를 마치 윈도우 처럼 사용할 수 있도록 자세히 알려준다.

그리고 책의 후반부에는 서버와 DB 구축 MariaDB 설치 및 비주얼 스튜디오와 연동하는 방법 등 무료로 사용 가능한 무료 프로그램들을 사용하여 리눅스 환경을 구축하여 활용할 수 있도록 되어있다.

지금 리눅스를 첨 공부하는 사람이나 리눅스를 사용하고 있는데 어떻게 사용할지 모르는 사람들에게 추천한다. 책이 상당히 두꺼운 편이라 한 번에 다 읽기보다는 책꽂이에 꽂아 놓고 필요한 내용이 있을때 마다 사전 처럼 찾아서 보면 좋을 것 같다.

"한빛미디어 <나는 리뷰어다> 활동을 위해서 책을 제공받아 작성된 서평입니다."

도서 ‘프로덕트 매니저는 무슨 일을 하고 있을까‘ 리뷰

프로덕트 매니저는 무슨 일을 하고 있을까
개점휴업.최민 지음 / 한빛미디어 / 2023년 1월

회사에서 두 개 프로젝트의 PD와 PM을 맡고 있다. 일정 관리도 전체적인 업무 관리도 잘 해내고 있다고는 하는데, 기획 업무도 그랬고 PM 업무도 사수 없이 하고 있다 보니 롤 모델이라고는 인터넷이 전부인 그런 상황이다. 다행히 매출도 잘 오르고 있고 순조롭긴 한데, 3년째 정체되어 있는 느낌이라 더 나아가기 위해 공부를 해야겠다고 생각했다.

그러던 중에 발견한 한빛미디어의 신간, '프로덕트 매니저는 무슨 일을 하고 있을까'. 부제가 무려 '일 잘하는 PM이 되기 위한 실무 밀착 가이드'다. 개발 서적만 내는 줄 알았더니 이런 기특한 책이라니! 마침 딱 반가운 책이다.​

기획자로서의 자기 개발이라면 넘치듯이 할 일도 많고 목표도 많은데, PM으로써 자기개발은 어떻게 해야 하는 걸까. 내가 지금 PM으로써 어느 정도 위치에 있을까. 도통 어려운 그런 고민들을 하고 있을 때, 길을 보여주는 책이다.​

제품의 정의부터 제품을 만드는 절차와 단계별 과업. 그리고 제품 구현 방법론. 참고로 우리 회사는 애자일을 쓴다. 그리고 제품을 만드는 사람. 누군가 알려주지 않고 사수도 없는 PM의 일에서 하나하나 인터넷을 친구 삼아서 해나가고 있는 일들. 그걸 좀 더 체계적인 이론으로 배울 수 있는 책이다. 만약 이제 막 PM을 맡게 되었거나, PM이 되기를 앞두고 있다거나, 아니면 PM이 되기를 바라는 사람이 있다면 이 책을 꼭 만나보길 바란다.​

이 책은 프로덕트 매니저의 정의와 업무 범위, 프로덕트 매니저의 역량과 커리어 패스를 통해 프로덕트 매니저가 하는 일을 이해시켜 준다. 3번째 챕터부터는 보다 실무의 영역을 파고든다. 기획서, 요구사항 정의서, 지표 설정, 유저 스토리, 화면 설계서, 제품 구현 단계와 그 과정에서 생길 수 있는 이슈들, 테스트와 릴리즈, 릴리즈 전 릴리즈 이후를 위해 미리 대비해야 하는 것들. 그리고 운영은 어떻게 할 것인지까지 실무적인 영역을 다채롭게 다룬다. 누가 이런 책을 기획했는지 정말 고마워 죽겠다. ​

PM 업무와 연관 있다면 있고 없다면 없는 업무 환경에서의 커뮤니케이션 방법들, 그리고 PM의 자기 개발은 어떻게 하는지, 리더의 역할이란 무엇인지 고작 250 페이지 이내의 이 두껍지 않은 책을 통해 모두 배울 수 있다. 딥하게 세부 영역을 파고들지는 않지만, 내가 PM으로써 잘 하고 있는 것인지 의문이 드는 시점에 적절하게 고민들을 해결해 준다. 물론 회사마다 프로세스가 다르기 때문에 여기서 배운 것들을 그대로 적용할 수가 없을 때도 있고 때론 '이건 아닌데..?'라는 생각이 들 수도 있지만, 적어도 정석은 어떤 것인지, 내가 어느 정도 수준에 다다랐는지, 앞으로 무엇을 더 노력해야 하는지를 알 수 있는 것만으로도 책값이 아깝지 않다고 생각했다. 이 책은 한빛 미디어의 리뷰 활동을 통해 제공받은 책이지만, 나는 이 책을 신청하기 전에 이미 이 책을 사비로 구입해서 소장하고 있다. 굳이 가지고 있는 책을 한 번 더 신청한 것은 신청한 세 권의 책 중, 이 책이 당첨이 될 경우 사내에서 같이 PM 업무로 골머리를 쌓는 다른 동료에게 선물하기 위함이었다. 이 책이 내게 온 것을 보면 역시 좋은 책은 함께 보라는 계시일까..!

 "한빛미디어 <나는 리뷰어다> 활동을 위해서 책을 제공받아 작성된 서평입니다."

도서 ‘파이썬 기반 금융 인공지능‘ 리뷰

파이썬 기반 금융 인공지능 - 파이썬과 케라스를 활용한 금융 시계열 데이터 기반 알고리즘 트레이딩 전략
이브스 힐피쉬 지음, 김도형 옮김 / 한빛미디어 / 2022년 9월

파이썬 기반 금융 인공지능. 이 책은 금융 분야 전문가를 위한 책이다. 혹시라도 인공지능이란 단어와 금융이란 단어에 혹해서 책을 읽을 수도 있는데(그게 바로 내 이야기) 정말 많이 어려운 책이다. 수학과 언어에 능한 사람이라면 도전해 볼 만한 책이다. 

이 책이 소개 하는 내용은 기계 지능 인공지능을 알고리즘에 학습시키는 이론과 신경망 알고리즘의 기본적인 동작 원리 등을 파이썬을 활용하여 설명하고 있다.  책 머리말에 나오는 소스코드를 볼 수 있는 주소로 접속하면 간단한 회원 가입 후 책의 모든 소스 코드를 사용할 수 있다. 추가 웹에서 파이썬을 구동 하기 때문에 파이썬 설치와 코드 타이핑이 필요가 없어서 파이썬을 잘 다루지 못하는 사람들도 충분히 읽을 수 있는 좋은 책이다.​

다만, 책에서 소스코드를 다운로드할 수 있다는 링크를 찾아가면, 대단히 대단히 찾기 어렵게 되어 있다. 심지어 방문자가 방명록에 홈페이지 UX 별로라고 글을 써놓기도 할 정도. 정말이지 미로 찾기도 아니고 소스코드를 볼 수 있는 링크를 찾기가 굉장히 어렵게 되어있다. 그래서 겨우겨우 찾아낸 링크를 여기에 공개한다.

https://worker28.pqp.io:8001/tree/aiif/code

이 주소로 접속하면, 아래 그림처럼

책에 있는 모든 소스코드들이 있고

위에 실행 버튼을 누르면 타이핑 없이 실행도 가능하다.

위 이미지는 소스코드 사이트에서 실행 버튼 만으로 실행한 이미지 이다 책의 내용과 동일하게 출력되는 것을 확인 할수 있다.

인공지능의 설명을 하면서 지루하지 않도록 알파고에 대한 숨겨진 이야기라든지, 인공지능을 학습시켜서 게임기 게임을 플레이 시켜서 인간보다 더 높은 스코어를 올리게 한 사례 등을 설명한다. 평소에 금융과 인공지능에 관심이 있거나 금융의 이론을 실제 시뮬레이션을 통하여 확인하고 싶은 분들에게 추천한다.

#한빛미디어 #파이썬기반금융인공지능 #파이썬금융