승상의 코딩 블로그

[도서 리뷰] 코드 밖 커뮤니케이션 - 재퀴리드 (한빛미디어) 본문

일상과 생각

[도서 리뷰] 코드 밖 커뮤니케이션 - 재퀴리드 (한빛미디어)

양승상 2024. 9. 21. 16:04

코드 밖 커뮤니케이션

처음엔 다른 책처럼 "UML 작성하는 방법 등이 설명되어있나?" 하면서 읽었던 책이다.

일단, 그런 책은 아니다.

이 책은 작성된 다이어그램, 문서, UML, ... 을 어떻게 "더 눈에 띄고 쉽게 읽히게 만들 수 있을까"에 대한 설명이 들어있다. 

* UML 말고도 다양하게 있지만, 나는 UML 을 보고 싶었기에 UML 에 대해서 적는다.


수 많은 글들이 세상에 있지만 대다수의 글은 제대로 읽혀지지 않는다.

GITHUB 에서 찾은 프로젝트의 README 가 제대로 써져있지 않으면, 프로젝트를 굳이 사용하지 않는다.

읽는 사람이 특정된 회사에서 작성하는 문서라도, 문서가 읽기 힘들면 읽지 않는다.

 

우리는 내 글이 읽힐 수 있어야하고, 읽혔다면 그대로 내용이 잘 이해되면서 술술 풀려가야 한다.

이 책은 읽힐 수 있도록 선택되도록 명확하고 간결하게 시각화하는 방법을 보여준다.

그리고 선택된 글/그림이 계속해서 읽혀질 수 있도록 어떻게 스토리텔링을 해야하는지도 알려준다.

책에서 소개하는 몇가지 방법 예시.
 - 큰 그림이 먼저다. 독자가 관심이 있다고 하더라도 세부 내용을 보여주면 안된다. 독자가 스스로 빠져들도록 맥락을 제공하는 것이 중요하다.
 - 흐름에 기대를 맞추자. 일반적으로 사람들이 기대하는 패턴을 적용하여 의식의 흐름을 끊지 않도록 한다. 글은 좌측위에서 우측아래로 일반적으로 읽히므로 다이어그램도 시작점과 끝을 이와 유사하게 맞춘다.
 - 독자는 관계를 통해 스토리를 이해한다. 관계를 명확히 한다.

 

관계를 통한 스토리텔링을 위해, 명확한 관계 패턴을 사용한다.

 

추가로, 프로젝트를 관리의 개념? 예를 들면, 프로젝트별로 지식을 관리하는것과 프로덕트로 지식을 관리하는 것의 차이도 흥미롭게 봤다.

또한, 폐쇄적인 환경(사내 인트라넷)에서 개발하는 경우 필요할 수 있는 오픈소스도 소개해주고 있다.

추천할 분

문서나 다이어그램을 작성한 뒤, 이를 개선해보고 싶은 사람(O)

문서나 다이어그램 작성 방법론을 알고 싶은 사람(X)

 

 

YES24 리뷰어클럽 서평단 자격으로 작성한 리뷰입니다

반응형
Comments