기술문서
-
기술문서 어떻게 작성해야 할까? 사용자 중심의 기술문서 작성하기기술문서 2021. 10. 25. 20:44
기술문서라고 하면 다양한 문서 유형의 문서들이 존재합니다. 하지만 다양한 문서 유형일지라도 '사용자(독자)'중심으로 작성해야 한다는 것입니다. 문서로 기록한다는 것은 비록 '나' 자신일지라도 독자는 반드시 존재하기 때문입니다. 기술문서를 처음 작성할 때 어려움이 따르지만 사용자(독자) 중심으로 글을 쓰고자 한다면 쉽게 방향을 잡을 수 있을 것입니다. 사용자(독자) 중심으로 어떻게 기술문서를 작성해야 하는지 정리해보고자 합니다. 기술문서를 작성하기 전 먼저 독자는 누구인지 독자의 수준은 어떤지 고려해야합니다. 일반 사용자 그리고 초보 개발자들을 위한 문서라면 문서에 사용된 용어 자체가 쉬운 용어로 작성되어야 합니다. 그리고 사용자가 반드시 필요로 하는 내용들만 기술하도록 해야합니다. 많은 정보를 제공하는 ..
-
기술문서(Technical Document)에는 어떤 문서들이 있을까?기술문서의 종류기술문서 2021. 10. 14. 20:56
지난번 " 기술문서(technical document)의 개념/중요성/범주는 무엇일까?"에서 기술문서의 범주와 예시에 대해서 간단하게 작성했다. 이번에는 대표적인 기술문서들에 대해서 보다 자세하게 작성해보고자 한다. 정말 다양한 문서들이 있겠지만 그중 대표적이고 가장 큰 범주들에 대해서 작성하고자 한다. API Guide/SDK Gudie 사실 나는 소프트웨어 쪽이 아니라 API가이드문서에 대해서 잘 알지 못한다😥 하지만 소프트웨어 테크니컬 라이터는 API가이드 문서 등을 작성하는 일이 많기 때문에 그래도 공부할겸 알아봤다. 여기서 API가이드를 알려면 API가 뭔지를 알아야 하는데 간단하게 설명하자면 [응용프로그램에서 사용할 수 있도록 운영체제나 프로그래밍 언어가 제공하는 기능을 제어할 수 있게 만든 ..
-
Technical Writing 4단계로 기술문서 작성하기기술문서 2021. 10. 5. 15:49
테크니컬 라이팅에서 쓰이는 테크니컬 라이팅 4대 원칙에 대해서 작성해보려고 합니다. 처음 테크니컬 라이팅 교육을 수강했을 때 가장 먼저 나오는 내용입니다. 반드시 이 원칙을 따라야 할 필요는 없지만 기술문서를 처음 작성해 보는 사람이라면 이 원칙에 따라 작성하는 것이 좋습니다. 테크니컬 라이팅의 4원칙 정확성(Accuracy), 명확성(Clarity), 간결성(Concisenness), 일관성(Consistency) 1. 정확성(Accuracy) 테크니컬 라이팅의 첫 번째 원칙은 정확성입니다. 정확성이란 특정 독자가 필요로 하는 내용에 대하여 기술적 오류 없이 정확한 정보를 제공하는 것입니다. 잘못된 정보가 포함된 기술문서면 독자가 처음부터 끝까지 그 문서를 이해한다고 해도 필요 없는 정보를 제공했기 때..