한빛미디어

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

테크니컬 라이터로서의 역할과 기술 문서 작성 방법에 대한 상세 가이드를 제공합니다.

[주요 용어]

테크니컬 라이터:

1. 일반인들에게 낯설고 어려운 기술 이야기를 사용자가 쉽게 이해할 수 있는 콘텐츠로 번역하는 직업(SK),
2. 개발자 중심의 기술 관련 용어나 설명을 독자가 쉽게 이해할 수 있도록 콘텐츠를 가공, 배포, 관리하며, 프로젝트 초기 단계부터 철저한 문서화 작업을 계획하고 수행(Kakao),
3. 전문적인 정보를 전달해주는 역할을 한다. 어떤 시설이나 장비에 대한 정보를 여러 사람에게 전달해주는 역할이다. 그 정보는 다양한 매체를 통해 다른 사람들에게 전달된다. 테크니컬 라이터는 다양한 매체(전자, 인쇄, 음성, 영상 등)를 통해 컨텐츠를 개발(Wiki)

[개요]

기술 문서를 포함 누군가에게 정보를 제공하기 위한 작업을 할 때 우선 정의와 목적을 분명히 해야 한다.

만들 문서에 대한 최소한의 양식이 제공되면 초안 작성과 문서 완성에 도움이 된다.

만든 문서를 이용하는 사람에게 도움이 되고, 필요한 경우 피드백 반영하고 여러 사람이 문서에 대한 편집 권한을 부여하는 등 지속성을 유지할 수 있는 방안도 제시되어야 한다.

기술 문서로서 좋은 샘플 코드들이 포함되어 실제 동작에 대한 설명이 가능해야 한다.

활용 가능한 문서로서 시각적 콘텐츠를 제공하여 이해가능성을 높여야 한다.

작성된 문서는 사용가능하도록 배포되어야 한다.

사용되는 문서는 지속적으로 피드백을 수집할 수 있는 채널을 열고 피드백에 대한 조치를 할 수 있어야 한다.

작성된 문서가 제대로 활용될 수 있는 문서 매트릭을 만들어 문서 품질을 측정할 수 있어야 한다.

문서를 활용하려는 사람이 쉽게 원하는 컨텐츠를 찾을 수 있도록 구조화해야 한다.

문서는 용도가 다할 때까지 최신성을 유지할 수 있도록 해야 한다.

20년이 넘도록 다양한 규모(1억~10억~100억~1000억~1조 규모)와 도메인 유형(공공, 유통, 금융, 물류, 교육 등)의 프로젝트에서 최적화된 관리와 다양한 수행 방법론(정보공학, 구조, 빅데이터, AI, 테스트, 이행, 운영 등) 제시하고 관련 방법론에 따른 문서를 수행 단계에 맞도록 테일러링하고 기술 문서를 포함한 수십에서 수백종의 각종 문서들의 템플릿을 제공하고 각 산출물들의 작성 가이드를 제공하여 프로젝트와 공정 단계의 완성을 보장하는 업무를 하고 있다.

Product나 Service, 특정 Solution에 해당하는 기술문서를 작성 및 가이드 하는 경우도 있다.

보잉(Boeing)은 최신 항공기 제작 과정에서 8,000개가 넘는 산업 소프트웨어를 사용했는데, 그중 1,000여 개만 상업 소프트웨어였고, 나머지 7,000여 개는 보잉이 자체 개발한 산업 앱이었다. 보잉은 몇십 년 동안 쌓아온 항공기 설계, 최적화 및 산업 기술과 공정 경험을 7,000여 개의 산업 앱에 담아 보잉만의 핵심 경쟁력을 만들어냈다.

이렇듯 산업 현장에서 테크니털 라이터의 존재가 중요해지고 있다.

추가로 기술 문서 작성 완벽 가이드(Docs for Developsers)는 테크니컬 라이터로 업무 수행 중인 담당자들의 현장이야기도 포함되어 있어 다른 회사의 상황도 살펴 볼 수 있다.