Scalenut, G2 Fall Leader 2022 - 콘텐츠 제작 부문 선정

과학자, 의사, 컴퓨터 프로그래머 및 엔지니어가 작성한 기사가 기술 문서에 해당한다고 생각하는 사람들이 있습니다.

또 다른 그룹은 테크니컬 라이팅이 사용자 매뉴얼 작성에 관한 것이라고 생각합니다.

둘 다 더 이상 틀릴 수 없습니다.

그러나 그들의 편견은 충분히 이해할 수 있습니다. 보통 사람의 경우, 이들은 그들의 언어로 '기술'이라고 부를 수 있는 전문가(의사, 과학자, 엔지니어 등)입니다. 그들은 소위 '기술적인' 사람들이 작성한 백서와 논문이 기술적인 글쓰기의 전부라고 가정합니다.

마찬가지로 사용 설명서는 기술적인 내용(사용하는 장비 및 제품)을 이해할 때 접하게 되는 문서입니다. 그래서 두 번째 편견에 답합니다.

그러나 진실은 대부분의 사람들이 테크니컬 라이팅이 우리와 같은 평범한 사람들을 위한 콘텐츠 작성에 관한 것이라는 사실을 깨닫지 못한다는 것입니다. 사실, 많은 기술 문서는 독자들이 실제로 찾고자 하는 것이 무엇인지를 철저히 이해한 후에야 작성됩니다.

이 가이드는 테크니컬 라이팅이 무엇인지, 일반 콘텐츠 작성과 어떻게 다른지, 테크니컬 라이터가 되기 위해 따라야 할 단계에 대한 깊은 이해를 제공하도록 신중하게 설계되었습니다.

테크니컬 라이팅이란?

몇 년 전 테크니컬 라이팅이 정의된 방법은 다음과 같습니다.

"프로세스, 소프트웨어 사용 설명서 및 장비 지침을 기록하는 관행."

과거에는 테크니컬 라이팅이 실제로 사용 설명서에만 국한되었습니다. 그러나 현대 세계에서 테크니컬 라이팅은 더 많은 정의를 포괄하는 포괄적인 용어가 되었습니다.

오늘날 테크니컬 라이팅은 다음과 같이 정의됩니다.

“거의 모든 분야에서 기술 프로세스의 문서화. 여기에는 보고서, 브리핑, 지침 등이 포함됩니다."

공학, 정보 기술, 생명 공학, 금융 등과 같은 다양한 분야에 있을 수 있습니다.

간단히 말해서, 기술 분야에서 일하는 경우 누군가가 귀하와 귀하의 제품 또는 서비스에 대한 기술 문서를 작성하고 있습니다.

테크니컬 라이팅의 목적은 무엇입니까?

테크니컬 라이터는 함께 작업하는 산업 및 회사에 따라 역할과 책임이 변경될 것으로 예상할 수 있습니다. 그러나 대부분의 테크니컬 라이터는 여러 팀과 함께 작업합니다. 그들은 기술 직원과 기술이 부족한 직원 및 고객을 연결하는 다리입니다. 기술 작가로서 기술 직원이 이해하는 언어로 독자에게 전달하고자 하는 내용을 정확하게 전달하는 것은 귀하의 책임입니다.

간단한 예를 들어보겠습니다. 귀사는 새로운 영업 지원 도구를 마련했습니다. 최종 고객에게 이메일을 시작, 일시 중지 및 예약하는 여러 기능이 있습니다. 일반 사용자는 응용 프로그램을 최대한 활용하려면 이러한 모든 기능에 대해 배워야 합니다. 이제 사용자가 스스로 기능을 찾도록 하거나 각 기능이 무엇이며 어떻게 사용하여 삶을 더 단순하게 만드는지 설명하는 문서를 제공할 수 있습니다.

기술에 정통하지 않은 사용자에게는 이것이 도움이 될 것입니다. 이 문서가 없으면 응용 프로그램을 이해하고 탐색하는 것이 상당히 어려울 수 있습니다. 더 나은 경험을 제공할 수 있는 기능을 놓치거나 특정 기능을 부적절하게 사용할 수도 있습니다.

요약하면, 테크니컬 라이팅의 궁극적인 목적은 이러한 모든 함정을 피하고 정보가 명확하고 간단하게 전달되도록 하는 것입니다.

테크니컬 라이팅과 다른 글쓰기의 차이점은 무엇입니까?

이전 섹션에서 테크니컬 라이팅의 핵심 아이디어는 명료한 방식으로 정보를 전달하는 것이라고 인용했습니다. 그러나 다른 형태의 글쓰기에도 해당되는지 궁금할 것입니다. 결국 모든 기사는 독자가 이해할 수 있는 언어로 사용자에게 일부 정보를 전달하기 위한 것입니다. 음, 유사점은 거기서 시작되고 끝납니다. 테크니컬 라이팅과 다른 형태의 라이팅 사이의 주요 차이점은 다음과 같습니다.

초점 영역

기술 문서는 관련 주제에만 초점을 맞춥니다. 예를 들어 사용 설명서는 제품의 기능에만 초점을 맞춥니다. 그러나 다른 형태의 글쓰기는 콘텐츠에 훨씬 더 많은 주제와 창의성을 불어넣을 수 있습니다. 예를 들어, e-러닝에 관한 블로그는 수업을 더 잘 진행하기 위한 팁과 자신의 e-러닝 아카데미를 시작하는 데 드는 예상 비용에 대해 이야기할 수 있습니다.

의도된 목적

다른 형태의 글이 정보를 전달하더라도 해당 콘텐츠의 목적은 일반적으로 마케팅을 위한 엔터테인먼트입니다. 반면 기술 콘텐츠는 사용자 경험 개선에만 초점을 맞춥니다. 정보를 제공하고 지침을 제공하며 주제, 응용 프로그램 또는 장비에 대한 설명을 제공합니다. 그게 전부입니다.

콘텐츠의 톤

비기술적인 콘텐츠는 일반적으로 주관적인 어조로 작성되며, 콘텐츠를 더 흥미롭게 만들기 위해 의견과 일화가 사용됩니다. 반면 기술 문서 작성은 본질적으로 항상 객관적입니다. 주어진 지침에는 의견이나 어떤 종류의 혼란도 있어서는 안 됩니다.

체재

일반적인 글쓰기는 여러 형태를 취할 수 있습니다. 예를 들어, 블로그를 독자에게 흥미롭고 재미있게 만들기 위해 블로그를 작성하는 데는 다양한 형식이 있습니다. 하지만 테크니컬 라이팅은 그렇지 않습니다. 테크니컬 라이팅에는 항상 따라야 할 정해진 구조가 있습니다. 이렇게 하면 전달되는 정보가 요점을 바로 전달하고 최종 사용자가 즉시 제품 사용을 시작할 수 있습니다.

작문 스타일

일반 글쓰기와 기술 글쓰기의 또 다른 주요 차이점은 음성입니다. 비기술적인 콘텐츠에서 작가는 종종 1인칭 형식과 비공식적인 어조를 사용하여 콘텐츠가 대화적이고 매력적으로 느껴지도록 합니다.

테크니컬 라이팅에서 독자의 편의를 위해 콘텐츠는 항상 3인칭 형식으로 작성됩니다. 또한 제공된 콘텐츠에 대한 다양한 해석을 위한 공간을 허용하지 않도록 매우 형식적입니다.

어휘

이 둘의 또 다른 주요 차이점은 사용되는 어휘입니다. 일반적인 콘텐츠 작성에서 사용되는 어휘는 종종 본질적으로 독자의 행동이나 감정을 불러일으키기 위해 연상적입니다.

테크니컬 라이팅에서 어휘는 고도로 전문화되어 있으며 제품 유형에 따라 다릅니다. 독자를 돕기 위해 정확한 지침이나 설명을 제공하기 위해 콘텐츠에 사용되는 전문 용어를 볼 수 있습니다.

청중

물론 청중도 둘 사이에 크게 다릅니다. 테크니컬 라이팅에서 청중은 항상 전문화되어 있고 자신의 내용을 알고 있습니다. 그들은 귀하의 제품이나 서비스를 구매할 사람들입니다. 프로그램이나 서비스를 더 잘 활용하기 위해 정보가 필요한 비즈니스 분석가나 제품 관리자일 수도 있습니다. 여기에서 테크니컬 라이터는 필요한 모든 이해 관계자가 필요한 정보를 적시에 얻을 수 있도록 하는 것이 그들의 목표임을 알게 될 것입니다. 작가들은 더 많은 사람들이 그것을 읽도록 유도하라는 압력을 받지 않습니다.

다른 형태의 글쓰기에서는 청중이 훨씬 더 일반화됩니다. 연령대, 직업 등에 따라 큰 차이가 있을 수 있습니다. 요컨대, 이 글이 특정 대상을 대상으로 하는 사람들은 없습니다. 작가는 또한 더 많은 사람들(주제에 관심이 있는)에게 방송되는 콘텐츠에 집중해야 합니다.

테크니컬 라이팅 예시

다음은 가장 인기 있는 테크니컬 라이팅 예시 또는 테크니컬 라이터가 작성한 콘텐츠 유형입니다.

표준 운영 절차

이들은 조직 내에서 적절한 운영 절차에 대한 지침 및 정보 콘텐츠를 사용자에게 제공하기 위해 고안된 문서입니다. 이러한 문서는 프로세스 및 상황에 대한 규칙, 규정 및 지침을 다룹니다. 또한 에스컬레이션 절차 및 특정 상황에 대해 연락할 사람에 대한 정보도 제공합니다.

사용 설명서

우리 대부분은 사용 설명서에 익숙합니다. 스마트폰과 같은 새로운 전자 기기를 구입할 때 받는 작은 소책자일 수도 있고, 자동차와 같은 더 큰 물건과 함께 받는 두꺼운 책일 수도 있습니다. 이 모든 문서는 기술 작가가 작성합니다. 여기서 작가는 장치나 장비를 올바르게 사용하는 방법에 대한 정보를 제공하는 것을 목표로 합니다.

법적 면책 조항

이를 헤지 조항이라고도 합니다. 그들은 일반적으로 조직이 제품이나 서비스를 사용할 때 책임이 있는 것과 그렇지 않은 것에 대해 독자에게 면책 조항을 제공하기 위해 작성됩니다. 테크니컬 라이터는 종종 법률 전문가 및 제품 개발자와 상의하여 법적 면책 조항에 무엇을 쓸 수 있고 쓸 수 없는지 이해해야 합니다.

법적 고지 사항은 제품 또는 서비스가 판매되는 시장에 따라 복잡성 수준이 추가됩니다. 국가마다 회사가 해당 지역의 고객을 지원하고 서비스하기 위한 법적 요구 사항이 다르기 때문입니다.

다른 많은 유형이 있습니다. 위에서 언급한 것들은 참조를 위한 몇 가지 기술적인 작성 예일 뿐입니다.

테크니컬 라이터가 되려면 어떻게 해야 합니까?

테크니컬 라이터가 되는 데 관심이 있다면 좋은 소식이 있습니다. 이 분야에 진출할 수 있는 방법이 많을 뿐만 아니라 전 세계 기업에서 테크니컬 라이터에 대한 수요가 항상 증가하고 있습니다. 제품, 서비스 및 프로세스에 대한 기술 문서를 작성하려면 귀하의 도움이 필요합니다. 그 긍정적인 측면에서 테크니컬 라이터가 되기 위해 할 수 있는 다양한 일들이 있습니다.

글쓰기 배우기

이것이 당연하게 들릴 수 있지만 쓰기 학습은 문장을 함께 연결하는 것과 관련이 없습니다. 작문 유형에 따라 다른 성부를 사용하고 삽화를 명확하게 설명하고 참조하는 방법 등 작문 내에서 다양한 하위 주제를 배워야 합니다.

쓰기의 다른 단계를 알고

거의 모든 테크니컬 라이팅 프로젝트에는 다음 세 단계가 있습니다.

#1. 계획

프로젝트 계획은 종종 고용주나 고객이 시작합니다. 이 단계에서는 문서의 유형, 주제, 목표, 범위 및 대상 청중과 같은 기본 요구 사항을 정의합니다.

처음에 모든 것이 제공되지 않으면 클라이언트 또는 고용주와 대화를 통해 대화를 통해 세부 정보를 얻어야 합니다. 때때로 그들은 그들이 찾고 있는 것이 무엇인지 확신하지 못할 수도 있습니다. 테크니컬 라이터로서 귀하의 임무는 프로젝트를 완료하는 데 필요한 요구 사항을 전달할 수 있는지 확인하는 것입니다.

적절한 질문과 대화를 통해 이 단계를 수행하면 많은 시간과 노력을 절약할 수 있습니다.

#2. 청중 요구 사항 이해

첫 번째 단계에서 잠재고객의 범위를 좁힐 수 있었다면 두 번째 단계에서는 잠재고객이 누구이며 무엇을 찾고 있는지 이해해야 합니다.

글쓰기를 시작하기 전에 청중에 대해 가능한 한 많은 정보를 수집하십시오. 예를 들어 독자가 해당 분야에 대한 전문 지식을 가지고 있습니까? 복잡한 용어와 전문 용어를 이해할 수 있습니까? 아니면 해당 분야에 완전히 새로운 사람입니까?

또한 청중은 기술 문서를 읽을 때 어느 정도 기대를 할 수도 있습니다. 그들은 무엇을 찾고 있을까요? 그들은 제품에 대한 심도 있는 이해를 찾고 있습니까, 아니면 그냥 제품 사용 방법을 알고 싶어하는 평신도입니까? 독자가 정말로 원하는 것을 제공하면 전체 쓰기 과정이 결정됩니다. 기억하십시오 – 그들은 질문을 하고 있으며 귀하는 정확한 답변을 제공해야 합니다.

또한 API에 대한 문서를 찾는 개발자는 조립해야 하는 새 가구를 구입한 고객과 완전히 다릅니다. 이들은 기술 문서에서 서로 다른 요구 사항을 가진 서로 다른 두 대상입니다.

#삼. 청중을 위해 쓰기

청중의 요구 사항을 이해한 후 이러한 요구 사항을 해결하기 위해 문서를 만드는 방법을 이해합니다. 작성자가 저지르는 경향이 있는 일반적인 실수는 다른 작성자가 매우 잘 받아들일 수 있지만 최종 사용자에게는 거의 또는 전혀 가치를 제공하지 않는 문서를 작성하는 것입니다.

따라서 키보드로 타이핑을 시작하기 전에 스스로에게 다음 질문을 해보십시오.

• 내가 작성하는 대상이 문서에 쉽게 액세스할 수 있습니까?
• 문서가 청중의 관점에서 이해하기 쉬운가?
• 독자는 이 문서를 어떻게 사용할 것입니까?
• 이 문서는 탐색하기 쉬운가요?
• 문서가 독자에게 너무 복잡합니까?
• 문서가 독자에게 너무 단순합니까?

테크니컬 라이팅 기술 개발

어느 분야를 선택하든 해당 분야에는 일정 수준의 기술 전문 지식이 필요합니다. 구문, API 및 프로그래밍 언어가 무엇인지 모르면 소프트웨어 문서를 작성할 수 없습니다. C++에 대한 문서를 작성하려면 최소한 C++의 작동 방식을 알아야 합니다. 그것으로 코딩할 수 있다면 더 좋습니다.

많은 연구를 하십시오

이것은 단지 다음 테크니컬 라이팅 과제를 작성하는 방법에 대해 배우기 위한 것이 아닙니다. 사용자에게 용어와 개념을 더 잘 설명할 수 있도록 해당 분야에서 일어나는 일에 뒤지지 않기를 원합니다. 청중이 고급 소프트웨어 프로그래머로 구성되어 있는 경우 콘텐츠가 그들에게 유용한지 확인하려면 그들의 수준을 유지해야 합니다.

이러한 모든 테크니컬 라이팅 기술을 통해 풀타임으로 하든 테크니컬 라이팅 프리랜서 프로젝트를 시작하든 관계없이 테크니컬 라이팅의 역할을 맡을 준비가 된 것입니다. 그러나 테크니컬 라이터로 준비하는 것은 지속적인 경험이라는 점을 기억하는 것이 중요합니다.

테크니컬 라이터의 역할

글쓰기는 테크니컬 라이터의 한 부분이지만 중요한 역할이기도 합니다. 모든 프로젝트를 수행할 수 있는 완전히 구체화된 테크니컬 라이터가 되려면 테크니컬 라이팅 작업을 수행할 때 맡게 될 모든 역할을 이해하는 것이 중요합니다.

문서 작성, 편집 및 교정

물론 작가로서 기술 문서를 작성하는 방법을 알아야 합니다. 위에서 언급한 바와 같이 여기에는 사용 설명서에서 법적 고지 사항에 이르기까지 다양한 문서가 포함될 수 있습니다. 또한 테크니컬 라이터는 문서의 정확성과 가독성을 보장하기 위해 문서를 편집하고 교정해야 합니다. 팀의 다른 테크니컬 작가와 함께 작업하는 경우 서로의 글이 품질 기준을 충족하고 필요한 정보를 청중에게 전달하는지 확인하기 위해 서로의 글을 확인하게 됩니다.

프로젝트 이해관계자와 협력

모든 프로젝트에는 개발자, 엔지니어, 관리자, 고객 및 기타 이해 관계자가 있습니다. 귀하의 업무에는 문서에 필요한 내용, 전달 대상, 포함 내용에 대해 조정하고 의사 소통하는 것도 포함됩니다.

또한 특정 프로젝트에 어떤 종류의 예산을 사용할 수 있는지 이해하고 그에 따라 시간, 리소스 및 노력을 할당해야 합니다. 특정 프로젝트를 완료하는 데 리소스나 시간이 충분하지 않은 경우 프로젝트 관리자와 리더로부터 해당 리소스를 확보할 수 있는지 확인해야 합니다.

문서 제공을 위한 실험적 소프트웨어 작업

정기적인 릴리스 업데이트가 있는 소프트웨어에 대해 작성하는 경우 각 업데이트에 포함되는 내용을 사용자에게 교육하기 위해 실험용 소프트웨어의 기능과 기능을 이해해야 합니다. 여기에는 패치 노트, 버그 수정 등이 포함될 수 있습니다. 일반적으로 패치 노트 및 버그 수정은 기존의 기술 문서보다 훨씬 짧지만 릴리스 일정은 더 잦습니다.

표준 및 지침 평가 및 권장

테크니컬 라이터는 작업 중인 프로젝트나 조직에 따라 특정 지침과 표준을 준수하게 됩니다. 이러한 지침과 표준은 다른 경우에 업데이트되고 변경되어야 합니다. 프로세스와 제품은 변경되므로 청중, 제품/서비스 및 조직의 요구 사항을 충족하는지 확인하기 위해 표준과 지침을 때때로 검토하고 모니터링해야 합니다.

테크니컬 라이팅에 필요한 기술

이것을 당신의 직업으로 삼고 싶다면 글쓰기보다 더 많은 기술이 필요하다는 것을 이해하십시오. 훌륭한 테크니컬 라이터는 훌륭한 기술 문서를 작성할 수 있도록 다양한 기술을 보유하고 있습니다. 테크니컬 라이팅에 필요한 다양한 기술은 다음과 같습니다.

#1. 작문 기술

이것은 주어진 것입니다. 테크니컬 라이터는 청중이 문서를 쉽게 이해할 수 있도록 완벽한 언어 기술과 문법, 어조 및 어휘에 대한 깊은 이해가 있어야 합니다.

#2. 연구

테크니컬 라이터는 주제를 깊이 파고들고 다른 방법으로는 찾기 어려운 정보를 찾는 방법을 알아야 합니다. 독자는 문서를 읽을 때 전체 그림을 알고 싶어하며 무거운 작업을 수행하는 것은 귀하에게 달려 있습니다.

#삼. 팀워크

다른 기술 작가, 엔지니어, 팀 리더, 관리자 및 법률 전문가와 함께 작업하는 팀의 일원이 되는 경우가 많습니다. 훌륭한 테크니컬 라이터가 되려면 팀과 효과적으로 작업하는 방법을 배워야 합니다.

#4. 단일 소싱

단일 소싱을 사용하면 동일한 소스 문서를 사용하여 여러 문서를 생성할 수 있습니다. 이는 동일한 소스 문서를 사용하여 다른 대상을 위한 여러 사용자 가이드를 만들어야 하는 작업이 있는 경우 유용합니다.

한 청중은 고급 사용자일 수 있고 다른 청중은 완전한 평신도일 수 있습니다. 여기에서 단일 문서를 참조하고 각 대상에 대해 여러 문서를 생성하면 시간과 리소스를 효과적으로 관리하는 데 도움이 될 수 있습니다.

#5. 체계적인

테크니컬 라이팅은 철저하면서도 가독성을 잃지 않아야 합니다. 잘 조사된 기술 문서라도 적절하게 구조화되고 제시되지 않으면 쓸모가 없습니다. 독자는 문서를 탐색하는 데 어려움을 겪을 것이며 독자가 이해하기 힘든 일이 될 것입니다. 글을 체계적이고 체계적으로 작성하면 프로젝트를 더 빨리 완료하는 동시에 청중이 작업에서 명확하고 효과적으로 가치를 도출할 수 있습니다.

#6. 웹 디자인 기술

오늘날의 연결된 세상에서 대부분의 문서는 소비할 목적으로 종이에 기록되는 경우가 거의 없습니다. 이것은 선택 사항이지만 웹 디자인 및 개발 기술을 배우는 것은 지침 및 정보를 찾는 온라인 사용자가 웹 사이트에서 문서에 쉽게 액세스할 수 있도록 하는 데 도움이 될 수 있습니다.

마무리

테크니컬 라이팅 프리랜서 작업을 할 계획이든 현장에서 풀타임으로 일할 계획이든 상관없이 위에서 언급한 모든 것을 이해하고 숙달해야 합니다. 테크니컬 라이팅 작업은 수백만 명은 아니더라도 수천 명에게 명확하고 쉽게 이해할 수 있는 정보를 제공하기 때문에 올바르게 수행할 경우 매우 보람이 있을 수 있습니다.

그러나 동시에 위의 예에서 본 바에 따르면 서비스를 제공하려는 각 분야의 최신 트렌드, 시장, 혁신 등을 파악해야 하는 매우 까다로운 직업이기도 합니다. .

기술 콘텐츠가 필요하고 AI 기반 품질 보증으로 뒷받침되는 환상적인 사용자 설명서를 구성하기 위한 전문 서비스가 필요한 경우 Scalenut은 필요한 모든 전문 지식을 갖추고 있습니다. 귀하의 요구 사항을 지금 저희에게 알려주십시오.