기술 문서 작성 시 Excel을 사용하기 위해 주제 전문가가 될 필요는 없습니다.

많은 사람들은 훌륭한 테크니컬 라이터가 되려면 해당 분야의 전문가가 되어야 한다고 믿습니다. 이것이 일반적인 오해이기는 하지만, 사람들이 이러한 믿음을 갖고 있다는 것은 놀라운 일이 아닙니다. 결국, 기술 작가로서 귀하의 임무는 복잡한 기술 정보를 이해하기 쉬운 방식으로 청중에게 전달하는 것입니다. 물론 사람들은 당신이 그 주제에 대해 깊이 알고 있기를 기대합니다.

다행히도 현실은 세계적 수준의 기술 기사를 작성하기 위해 SME가 될 필요는 없습니다. 당신은 무엇을 하다 필요한 것은 호기심, 체계, 그리고 해당 분야 전문가에게 올바른 질문을 하려는 의지입니다. 이것이 바로 기술 문서 작성의 아름다움입니다. 모든 답을 아는 것보다 올바른 질문을 하는 것이 더 중요합니다.

훌륭한 기술 사례를 위한 비SME 가이드

1. 전문성 부족을 무기처럼 휘두르세요

훌륭한 기술 문서 작성은 학습자의 사고방식에서 시작됩니다. 당신이 그토록 걱정하는 전문성의 부족은 당신에게 흥미로운 이점을 제공합니다. 즉, 동일한 지식으로 주제에 접근할 수 있는 기회입니다. 초록색 그리고 호기심 당신의 잠재 독자들이 그럴 것입니다. 전문가들이 잊어버린 질문(독자들도 조용히 묻는 질문)을 묻고, 모든 개념을 조사하고, 전문 용어를 일반 언어로 분해하고, 자신의 지식 격차를 채워 독자에게 최고의 경험을 제공합니다. 실제로 애리조나 대학의 연구에 따르면 일단 무언가를 알게 되면 그것을 알지 못한다는 것이 어떤 것인지 상상하기가 어려워진다는 사실이 밝혀졌습니다. 이를 ‘지식의 저주’라고 합니다.

2. 주제 전문가와 관계 구축

우리는 훌륭한 기술 스토리를 작성하기 위해 SME가 될 필요는 없다는 사실을 확인했습니다. 누구 있어야합니다. 그리고 그 사람(또는 자원)과 관계를 구축해야 합니다. 당신이 쓰고 있는 기술 프로젝트/주제 뒤에 있는 두뇌와의 연결이 필요합니다. 해당 주제에 대해 알아야 할 모든 것을 아는 사람.

그러면 당신의 임무는 이 사람의 통찰력과 독자 사이를 연결하는 다리가 되는 것입니다.

그러나 SME의 경우는 다음과 같습니다. 그들은 종종 자체 시스템의 복잡성 속에서 깊은 곳에 살고 있습니다. 당신은 그러한 통찰력을 끌어내어 이를 여행에 도움이 되는 것으로 번역하기 위해 존재합니다. 하지만 그러기 위해서는 잘해야 한다. 신뢰를 쌓으세요. 그들의 작업을 정확하게 표현하고, 사려 깊은 질문을 하고, 그들의 시간을 존중하는 마음으로 처리할 것이라고 믿으십시오.

중소기업과 소통하는 방법

• 먼저 숙제를 하세요. SME 회의에 빈 자리로 나타나지 마십시오. 구체적이고 지능적인 질문을 읽고, 조사하고, 준비하세요.
• “무엇”보다 “왜”를 물어보세요. “무엇”이 당신에게 말해주는가 무엇 지어졌습니다. “왜”가 말해준다 WHO 그것은 그리고 그것이 왜 중요한지. “이유”를 발견하면 독자들이 어쨌든 관심을 갖는 실제 상황을 발견하게 됩니다.
• 즉시 용어를 명확히 하세요. 이해를 속이지 마십시오. 기술적인 부분에서 용어를 잘못 사용하면 신뢰성이 손상될 수 있습니다.
• 모든 통화 후에 요약하세요. 이해한 내용에 대한 간단한 후속 조치를 보내고 동일한 내용인지 확인하세요. 나중에 비용이 많이 드는 재작성을 하지 않아도 됩니다.

3. 전사하지 말고 번역하세요

종이에 펜을 쓸 준비가 되면 전문가의 전문 용어를 페이지에 버리는 것이 당신의 임무가 아니라는 점을 기억해야 합니다. 누구나 그렇게 할 수 있습니다. 당신의 가치는 독자를 위해 그것을 얼마나 잘 해석할 수 있는지에 달려 있습니다.

실제로 이것은 전문 용어를 일반 언어로 줄이는 것을 의미합니다. 업무에 더 집중하세요. 어떻게 독자는 이를 뒷받침하는 모든 흥미로운 기술보다는 제품/서비스의 영향을 받게 될 것입니다.

그래서 말하는 대신에, “제품 XYZ는 동종 최초의 첨단 기술로 제작되었기 때문에 훌륭합니다.” \n 말하길,“최첨단 어쩌고 저쩌고 만들어진 XYZ 제품은 ABC를 하는 데 도움이 되기 때문에 훌륭합니다.”

차이점이 보이시나요? 첫 번째 줄은 기술을 돋보이게 합니다. 두 번째는 독자에게 봉사합니다.

결국 전문 지식과 일상적인 이해 사이에 다리를 놓게 됩니다. 다리가 깨끗할수록 더 많은 사람이 건널 수 있습니다.

4. 당신의 인생이 달려 있다는 사실 확인

특히 SME가 아닌 경우 이는 선택 사항이 아닙니다. 기술적인 이야기는 정확성에 달려 있습니다. 산문과 달리 사실은 100% 사실이고 검증 가능해야 하며, 코드는 작동해야 하며, 예제는 재현 가능해야 합니다. 스크린샷, 코드 조각, 통계 등 모든 것을 전문가에게 보내 확인을 받으세요. 당신은 신뢰 게임을 하고 있으며, 이메일 한 통으로 발견할 수 있는 오류보다 신뢰를 더 빨리 무너뜨리는 것은 없습니다.

5. 이야기를 들려주세요(키워드, “이야기”)

사실을 확인한 후 이야기를 구성하세요.

결국 기술적인 글쓰기는 여전히 글쓰기.

이는 구조, 흐름 및 보상이 필요하다는 것을 의미합니다. 당신의 작품을 고정시키세요 왜 (문제 또는 목표), 전개 어떻게 (귀하의 프로세스 또는 발견) 다음은 뭐야? (통찰력 또는 행동).

작업을 더 쉽게 하기 위해 우리는 정확한 3막 구조를 기반으로 실용적인 가이드를 만들었습니다.

:::팁
여기에서 시작하세요: 기술 스토리텔링 작성 템플릿.

:::

마무리: 좋은 질문을 해보세요. 친구에게 설명하듯이 글을 써보세요. 그리고 어디서부터 시작해야 할지 잊어버린 경우, 매번 명확성이 복잡성을 이긴다는 점을 기억하십시오.

이것이 주제 전문 지식 없이 기술 문서 작성 산업을 탐색하는 것에 대해 어느 정도 명확성을 제공하고 두려움을 완화하였기를 바랍니다.

다음 시간까지!

출처 참조