본문 바로가기

개발자를 위한 글쓰기 가이드3

유형별 테크니컬 라이팅 작성의 원칙 1. 메일 1-1. 독자가 궁금해할 내용을 작성하자. 더보기 안녕하세요. 제품화팀 나길동입니다. 번역 품질을 높이고 번역 시간을 단축하기 위해 번역 툴을 구매하고자 합니다. 구매하고자 하는 툴은 AutoSuperTran이며, 가격은 50만 원입니다. 그럼 확인 부탁드립니다. 감사합니다. 김종훈 드림. 다음 메일에서 나올법한 질문은? - AutoSuperTran을 사면 어떤 점이 나아지는가? - 번역 속도가 얼마나 빨라지는가? - 번역 품질이 높아지는가? - 비교 대상이 된 툴에는 어떤 것이 잇나? - 각 툴의 장단점은 무엇인가? 등등 독자가 궁금해할 내용을 모두 메일에 포함해야 합니다. 1-1. 인사말과 맺음말은 과하지도 부족하지도 않게 쓴다. ex) 안녕하세요. 00 그룹 00 개발000입니다. 추운 .. 2023. 2. 2.
기술 문서 작성법과 구조, 계획, 초안, 검토 1. 계획 세우기 & 구조 잡기 - 무엇을 쓸 것이고, 어떤 내용을 쓸 것인지 구체적이고 명확한 주제 선정. - 작성자가 가장 자신 있게 쓸 수 있고 확실하게 알고 있으며, 경험담과 사례도 많이 제시할 수 있는 것으로 정하는 것이 좋음 - 어떤 종류의 문서를 작성할 것인지 정한다. (ex. 메일, 회의록, 보고서, 가이드, 튜토리얼 2. 초안 작성 생각나는 대로 편하게 글을 쓰며, 쓰고 싶은 내용을 모두 쓴다. 독자가 궁금해할 내용, 전달해야 할 내용을 빠짐없이 추가하는 데에만 집중한다. 효과적으로 정보를 전달할 수 있게 정리해야 한다. 핵심부터 작성한다. / 정확한 내용을 빠르게 전달하는 것이 목적이므로, 핵심을 가장 먼저 작성하고, 내용을 작성한다. 제목에 요점을 담는다. 문장하나에는 주제를 하나만 .. 2023. 2. 1.
개발자를 위한 글쓰기 가이드 시작!! 1. 테크니컬 라이팅이란? 기술이나 과학 분야에서 정로를 정확하게 전달하기 위한 글쓰기를 의미한다. 2. 기술 문서의 특징이란? - 특정 독자( 개발자, 고객 )를 대상을 특정 목적을 갖고 특정 정보를 전달. - 어떤 작업을 수행하거나 어떤 주제를 쉽게 이해할 수 있도록 "정확한" 정보만을 전달한다. - "어떻게 써야 명확하게 잘 전달할 수 있을까?"에 초점을 맞춰서 전달한다. 3. 일반 글쓰기와의 차이? 일반 글쓰기에서는 주관적인 생각, 공상, 관념 들을 포함할 수 있지만, 기술 문서에서는 객관적인 사실, 정확한 정보만을 다뤄야한다. 4. 테크니컬 라이팅의 5단계 계획 세우기 - 문서의 목적과 문서를 읽을 독자 선정 - 문서 작성에 필요한 정보를 수집 구조 잡기 - 수집한 정보를 작업 순서에 따라 차례.. 2023. 2. 1.