Go민보다 Go

프론트엔드 개발자

기술 문서 2

기술 문서 배포를 위한 프로세스

🐾들어가며 Docs for Developers 의 chapter 7 문서 배포하기를 읽고 예시를 찾아보면서 같이 정리했습니다. 이번 챕터에서는 문서를 배포하기 위한 프로세스를 만드는 것을 목표로 합니다. ✨본격적으로 ✅문서 배포 문서 배포: 사용자가 콘텐츠를 읽고 따라할 수 있도록 하는 것을 의미하며, 소프트웨어가 릴리스되었음을 알리는 것과 유사하다. 완벽한 문서는 거의 없다. 문서 배포에 대한 두려움을 다루는 가장 좋은 방법은 배포 후에 피드백을 기반으로 그동안 했던 과정을 반복하는 것이다. 해당 챕터는 다음과 같은 내용으로 구성되어 있으나, 프로세스 구축과 타임라인 만들기를 위주로 내용을 정리하였습니다. 콘텐츠 릴리스 프로세스 구축하기 배포 타임라인 만들기 배포 확정 및 승인하기 독자에게 콘텐츠 알리..

Read 2024.03.03

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

🐾들어가며 Docs for Developers 의 chapter 6 시각적 콘텐츠 추가하기를 읽고 정리했습니다. 이번 챕터에서는 시각적 콘텐츠에 대한 장, 단점 그리고 접근성이 높은 시각적 자료를 만드는 것을 목표로 합니다. ✨본격적으로 ✅시각적 콘텐츠를 만들기 어려운 이유 그래픽 콘텐츠의 우월함은 아주 작은 공간에 최소한의 잉크를 사용하여 최단 시간에 갖아 많은 아이디어를 보는 사람에게 제공한다는 점입니다. - 에드워드 터프티(Edward Tufte) 정보 전달을 방해하는 시각적 콘텐츠의 특징 이해 용이성 접근성 성능 위와 같은 점이 부족하기 때문입니다. 이해 용이성을 높이자. Q. 이 콘텐츠가 독자에게 도움이 되는가? 독자는 자신의 관심사와 관련된 정보가 포함된 이미지에 더 주의를 기울이며, 다른 이..

Read 2024.02.25