기술 문서 작성을 위한 시각적 콘텐츠

🐾들어가며

Docs for Developers 의 chapter 6 시각적 콘텐츠 추가하기를 읽고 정리했습니다.

이번 챕터에서는 시각적 콘텐츠에 대한 장, 단점 그리고 접근성이 높은 시각적 자료를 만드는 것을 목표로 합니다.

✨본격적으로

✅시각적 콘텐츠를 만들기 어려운 이유

그래픽 콘텐츠의 우월함은 아주 작은 공간에 최소한의 잉크를 사용하여 최단 시간에 갖아 많은 아이디어를 보는 사람에게 제공한다는 점입니다. - 에드워드 터프티(Edward Tufte)

정보 전달을 방해하는 시각적 콘텐츠의 특징

• 이해 용이성
• 접근성
• 성능

위와 같은 점이 부족하기 때문입니다.

이해 용이성을 높이자.

Q. 이 콘텐츠가 독자에게 도움이 되는가?

독자는 자신의 관심사와 관련된 정보가 포함된 이미지에 더 주의를 기울이며, 다른 이미지는 아무리 아름답게 디자인되어도 무시한다.

접근성을 높이자.

Q. 일부 독자에게 사용하기 어렵지는 않은가?

아무리 좋은 의도더라도, 텍스트로 가득 찬 다이어그램은 시각적 콘텐츠에서 이득을 봐야 하는 난독증 독자에게 오히려 도움이 되지 않을 수 있다.

성능을 높이자.

Q. 콘텐츠의 크기와 포맷이 독자에게 도움이 되는가?

이미지를 로드하는 데 문제가 생길 정도로 커서는 안 된다.

✅좋은 시각적 콘텐츠를 만드는 방법

• 스크린샷 사용하기
• 콘텐츠에 맞는 다이어그램 유형 사용하기
• 다이어그램 그리기
• 비디오 콘텐츠 만들기

아래는 리스트의 상세 내용입니다.

스크린샷 사용하기

스크린샷을 사용할 때 주의해야 할 점

• 스크린샷을 소개하거나 가리키는 문장이 함께 나온다.
• 지시 사항이나 관련된 내용 근처에 나온다.
• 깔끔하고 불필요한 요소가 없어야 한다.
• 충분한 맥락과 함께 UI에서 관련된 모든 부분을 포함한다.
• 너무 크지도 작지도 않아야 한다.
• 텍스트 없이 스크린샷만 사용하지 말아야 한다.

콘텐츠에 맞는 다이어그램 유형 사용하기

• 상자와 화살표
  텍스트만으로 설명하기 어려운 개체 간의 관계나 데이터 흐름을 명확하게 보여줄 수 있다.

• 순서도
  프로세스를 문서화하는데 특히 유용하나, 일관성을 유지하고 도형 내의 모든 텍스트가 쉽게 읽혀야 한다.

• 스윔레인
  순서도와 유사하게 프로세스를 보여주며, 각 참여나자 개체는 자신만의 레인을 가지고 프로세스의 각 단계는 해당 레인 중 하나에서 발생한다.

다이어그램 그리기

다이어그램을 그릴 땐, 단순화하는 것을 목표로 삼아야 한다.

정보를 덩어리나 계층으로 나누면 독자에게 적합한 디자인을 만들 수 있고, 독자의 다양한 학습 지점에서 적절한 수준의 정보를 제공할 수 있다.

• 각 개체의 의미와 개체 간의 관계가 명확한가?
• 프로세스가 논리적인가?
• 독자가 다이어그램의 어느 지점부터 보아야 하는가?
• 시각적 콘텐츠 내의 텍스트는 읽고 이해하기 쉬운가?
• 일관성 있는 색상을 사용하였는가?
• 대체 텍스트를 작성하고 다이어그램의 위치가 맥락에 맞는가?
• 콘텐츠의 포맷이 적절한가?

비디오 콘텐츠 만들기

비디오 콘텐츠는 새로운 개념을 소개할 때 유용할 수 있으나, 제작에 필요한 비용, 유지 관리를 감당할 수 있는지 생각해 보자.

✅시각적 콘텐츠 관리하는 방법

• 검토하기
• 유지 관리하기

절대로 시각적 콘텐츠만 따로 검토하지 말고, 주변의 텍스트와 함께 확인하자.

• 글 내부에서 시각적 콘텐츠의 위치가 적절한가?
• 앞에 적절한 소개 문장이 있는가?
• 모바일이나 더 큰 화면에서 콘텐츠를 볼 때 위치가 바뀔 경우가 있는가?
• 사이트 성능에 영향을 주는가?

이미지를 만드는 데 사용하는 포맷이나 도구에 관계없이 이미지를 쉽게 업데이트할 수 있도록 원본 파일을 다른 사람과 공유해야 한다.

✔️결론

이번에는 기술 문서의 시각적 콘텐츠에 대해서 알아보았는데, 시각적 콘텐츠가 물론 콘텐츠로써 가지고 있는 정보에 대해 초점을 맞추는 것도 좋았으나, 가장 궁금했던 유지 보수와 관련한 문제에 대해서 어떻게 해결할 수 있는 지는 나오지 않아서 좀 아쉬웠습니다. 다이어그램 유형에 대한 예시를 첨부하고 싶었지만, 처음 접한 스윔레인도 있기도 했고, 여태까지 그린 콘텐츠들이 별로 좋지 않아 첨부하지 않았습니다. 기회가 된다면, 해당 내용을 토대로 다시 한 번 그려보고 싶네요.

이 글은 옵시디언을 통해 발행하였습니다.