본문 바로가기

로하맘의 일과 육아6

1단계: 계획하기 - 좋은 구성하는 법 구성이란, 기술 문서를 읽는 특정 독자가 필요한 내용을 쉽고 빠르게 찾고, 그 내용을 이해하기 쉽도록 각각의 정보들이 논리적으로 연결된 것을 의미합니다. 구성은 두 개 이상의 주제들을 논리적으로 배열할 수 있고, 각 주제 안에 있는 정보들을 논리적으로 배열할 수 있을 때 비로소 잘 된 구성이라고 할 수 있습니다. 예를 들면 주제 안에 단락, 리스트, 표, 이미지 등을 논리적으로 구성하는 것입니다. 그리고, 단락 안에 문장들을 논리적으로 구성하는 것 또한 좋은 구성의 중요한 부분입니다. 기술 문서를 작성하는 데 있어 구성은 가장 중요합니다. 왜일까요? 구성은 특정 독자가 필요로 하는 정보를 쉽게 찾을 수 있도록 하기 때문입니다. 예를 들면 독자는 목차를 사용해서 필요한 부분만을 찾아낼 수 있으며, 작성자 .. 2024. 8. 26.
1단계: 계획하기 - 아웃라인 작성하기 지금까지 기술문서의 계획단계 중 4가지를 알아보았습니다. 먼저 기술 문서에 작성할 주제를 정하고, 기술문서를 읽을 특정 독자를 분석한 뒤, 기술 문서의 작성 목적을 분석합니다. 그리고 기술 문서의 종류를 선정하게 됩니다. 그렇다면 오늘 알아볼 1단계의 계획단계에서 더 나아가서 아웃라인의 목차를 작성하는 방법에 대해 알아봅시다. Formal Report의 아웃라인의 작성은 다음과 같습니다. 서두 (Front Matter)Title Page (필수)Revision HistoryAbstract (요약, 독자가 내 글을 읽을지 말지를 결정할 수 있는 브리프)Table of Contents (필수)List of Figures, List of TablesPrefaceAbbreviations and Definitio.. 2024. 8. 21.
1단계: 계획하기 기술문서의 작성 전에 반드시 특정 독자를 분석해야 합니다. 특정 독자를 구분하자면, 일차적 독자, 즉 기술 문서를 직접 사용하는 사람이 되겠고 이차적 독자와 같은 기술문서를 참고하는 사람이 있습니다. 이차적 독자는 프로젝트에 직접 참여하지는 않지만, 간접적으로 관련이 있는 사람입니다. 특정 독자의 분석 항목은 해당 기술 지식의 수준과 그들의 직급, 그리고 주요 관심 항목이 있습니다. 특정 독자를 분석하는 방법은 타사의 기술 문서의 작성 수준을 조사하여 그들의 이해 수준을 파악하는 방법과 해당 기술 지식의 수준에 대한 설문조사를 통하여 파악하는 방법이 있습니다. 특정 독자를 분석하는 1단계는 계획하기입니다. 특정 독자의 기술 지식 수준별 기술문서 작성의 방법은 기술적 지식수준이 높은 특정 독자를 타깃으로 .. 2024. 8. 20.
B2B 기술 문서를 작성하는 단계 내가 잘 만들었다고 생각하는 것이 꼭 품질이 좋은 B2B 기술문서가 되는 것은 아닙니다. 사용자 즉, 고객을 만족시키는 것이 바로 품질 좋은 B2B 기술문서가 되는 것입니다. 그것을 가능하게 하기 위해서는 B2B 기술적 글쓰기 이론, 사용성 평가, 사용성 테스트, 표준이 잘 따라서 작성이 되어야 합니다. 여기서 제가 앞서 포스팅한 내용을 토대로 상기해 봅시다. 기술적 글쓰기의 개념에 대해서 질문에 답해 보세요. "기술적 글쓰기는 무엇인가요?" 기술 문서 작성자가 특정 독기를 대상으로 특정 목적을 가지고 기술적인 정보를 정확하고 명확하게 글로써 전달하는 것입니다. 여기서 가장 중요한 점은 정확하고 명확하게 글로써 전달하는 것이란 점입니다. 부정확하고 모호하게 작성된 기술 문서는 기업 이미지와 신뢰에 부정적.. 2024. 8. 13.
테크니컬 라이터의 역할 테크니컬 라이터, 국문으로는 기술문서 제작자의 역할은 무엇일까요? 테크니컬 라이터는 B2B 기술문서를 작성하고, B2B 기술 문서를 작성하기 위한 조사를 진행합니다. 예를 들면, 자료를 수집하거나, 엔지니어와의 인터뷰를 통해서 필요한 정보를 얻고, 사용성 평가를 통해 사용성 테스트를 실시합니다. 또한, 스타일 가이드를 작성하여 배포하고, 템플릿을 만들어 배포할 수도 있으며, 만들어진 내용을 발표해야 할 수도 있습니다. 비즈니스 글쓰기를 통해 제안서를 작성하기도 하며, 화이트 페이퍼를 작성하여 배포하기도 합니다. 이들이 만드는 문서에서 소프트웨어 개발 문서를 예로 들면, 개발 계획서, 형상 관리 계획서, 요구 사항 계획서, 리스크 관리 계획서, 설계서, 분석서, 단위 시험 계획서, 통합 시험 계획서를 제작.. 2024. 8. 13.
테크니컬 라이팅의 개념 기술적 글쓰기의 작성자는 B2B 기술적 커뮤니케이터, 개발자, 엔지니어 등이 됩니다. 특정 독자란 주니어, 시니어 개발자, 엔지니어 등이 될 수 있습니다. 이 기술적 글쓰기의 특정한 목적은 기술적인 정보를 독자가 쉽게 이해하도록 함입니다. 기술적 글쓰기는 정확하고, 명확하며 일관성 있고 간결해야 합니다. 분야로는 소프트웨어, 전자, 의료, 반도체, 에너지, 생명과학 등 모든 기술 분야를 포함할 수 있습니다. 본인은 신발개발회사에서 신발개발에 대한 내용을 정리하여 제품을 양산할 수 있도록 하는 업무로서의 기술적 글쓰기를 하고 있습니다. 만약 정보 보안 설루션의 운영 매뉴얼을 만든다고 생각해 봅시다. 제목은 정보보안 설루션이며, 버전은 2.5, 운영 매뉴얼입니다. 특정 독자는 고객사의 보안 관리자, 일반 사.. 2024. 8. 12.