스타트업을 위한 기술 문서 작성이 중요한 이유: 이유는 다음과 같습니다.

새 시리즈의 첫 번째 블로그 게시물인 " 기술 문서 작성이 스타트업을 강화하는 방법 "에 오신 것을 환영합니다.

이 시리즈에서는 가시성 확보부터 청중과의 신뢰 구축에 이르기까지 기술 문서 작성이 스타트업에 어떻게 도움이 되는지 보여 드리겠습니다. 저는 스타트업에 글쓰기 서비스를 제공하는 사람으로서 잘 만들어진 콘텐츠가 긍정적인 영향을 미치는 것을 보았습니다.

오늘은 기술 문서 작성이 어떻게 스타트업의 성장을 촉진할 수 있는지에 대한 개요부터 시작하겠습니다. 글쓰기가 스타트업에 필수적인 도구인 이유에 대한 더 많은 게시물을 계속 지켜봐 주시기 바랍니다.

기술 문서 작성은 스타트업의 성공에 중요한 역할을 합니다. 여기에는 제품이나 서비스의 작동 방식을 설명하는 명확하고 간결하며 사용자 중심의 문서를 만드는 것이 포함됩니다. “ 강한 견해, 약한 견해. ” 자신을 드러내되 똑똑하고 존경하는 사람들의 반대 의견을 계속해서 찾아보세요.

소프트웨어 작성은 소설을 쓰는 것과 다리를 놓는 것 사이의 중간 단계입니다.

기술적인 글쓰기는 전통적인 출판이 수용할 수 없는 문체적 특이성을 용인하고 심지어 장려합니다. 그들에게 기대십시오.

기술 콘텐츠는 시의적절하거나 시대를 초월하며 그 사이에는 거의 아무것도 없습니다.

이미지 출처 - "개발자 관계 현황" - 여기에서 전체 보고서 에 액세스할 수 있습니다 .

조직/스타트업에서 계획을 적는 사람은 엄청난 힘을 가지고 있습니다. 기술 회사에서 유망한 인재를 찾고 싶다면 누가 계획을 작성하고 있는지 살펴보세요. 비록 그들이 모든 아이디어를 내놓을 수는 없더라도, 아이디어를 글로 정리하고 전달할 수 있는 에너지, 동기, 기술이 있다는 것을 알게 될 것입니다.

귀하의 제품이나 서비스에서 보는 모든 것에 대해 다양한 관점을 제시할 수밖에 없는 "측면적 사고가"로 귀하와 귀하의 스타트업을 둘러싸십시오. 항상 옳을 수는 없지만 항상 당신의 생각과 글쓰기에 도전합니다.

기술 문서 작성에 투자하면 스타트업의 성공에 상당한 영향을 미칠 수 있습니다. 이는 사용자에게 이익이 될 뿐만 아니라 내부 운영의 효율성과 효율성에도 기여합니다. 목표는 대상 청중이 명확하고 간결하며 이해할 수 있는 문서를 생성하는 것입니다. 결과적으로 사용자 만족도, 충성도, 비즈니스 성장이 향상됩니다.

기억하세요- 미디어 형식은 주기적입니다. Nietzsche는 격언을 썼고 Twitter는 격언을 서비스로 제공합니다. 힙합은 시를 다시 가져왔습니다. 몽테뉴는 에세이 형식을 개척했고 블로그를 통해 이를 다시 유행하게 되었습니다.

스타트업은 더 많은 선언문, 블로그, 깔끔한 문서, 통합 가이드를 작성해야 합니다.

기술 문서 작성이란 무엇입니까?

지난 3년 동안 저는 20개 이상의 스타트업을 대상으로 문서, 통합 가이드 및 기술 블로그 게시물을 작성하는 일을 해왔습니다. 저는 2021년에 Firebase Auth0의 대안인 SuperTokens 에서 개발자 옹호자 로 일하면서 기여하기 시작했으며 개발자가 새로운 오픈 소스 사용자 인증으로 전환하는 데 도움을 주었습니다.

나는 기술 블로그 와 문서 작성을 좋아하며, 다른 사람들에게 도움이 되는 고품질 기술 문서를 작성하는 것이 만족스럽습니다.

저는 수년에 걸쳐 많은 기술 문서 작성 및 문서 자료를 읽었습니다. 나는 왜 모든 엔지니어가 글을 써야 하는지 에 대해 글을 썼고, 나중에 내 경력의 핵심 사항을 기억하는 데 도움이 될 뿐만 아니라 지금 글을 쓰는 것에 대해 생각하는 데 도움이 되는 도구로 내 노트를 함께 모았습니다.

GPT는 얼마나 많은 글이 순수한 파브룸인지 밝혀냈습니다. 단조롭고, 생기가 없고, 통찰력이 없고, 공격적이지 않으며, 인쇄된 잉크 가격만큼 가치가 없습니다. 따라서 훌륭한 기술 블로그를 구축하고 작성할 수 있는 스타트업에게는 훌륭한 작가가 더욱 중요해질 것이며 ChatGPT 표절은 전혀 문제가 되지 않습니다. 기계를 능가할 수 없다면 무엇을 쓰고 있습니까?

기술 블로그 작성에 관심이 있는 개발자라면 기술 작성이 무엇인지, 그리고 좋은 기술 블로그를 작성하는 방법 에 대한 완전한 전용 블로그를 작성했습니다.

나의 글쓰기 원칙

나는 기술 문서 작성을 할 때 항상 다음 원칙을 염두에 두려고 노력합니다.

• 글쓰기의 목표는 사용자가 작업을 최대한 간단하고 효율적으로 만드는 것입니다.
• 개발자는 말을 듣는 것보다 보여지는 것을 선호하고, 행동을 통해 배우는 것을 선호합니다.
• 사용자가 가능한 한 빨리 첫 번째 성공을 거둘 수 있도록 도와주세요.
• 간단하게 유지하고 간단한 언어로 작성하세요.

스타트업에 기술 문서 작성이 중요한 이유는 무엇입니까?

저는 지난 3년 동안 기술 콘텐츠를 작성해 왔습니다. 내가 배운 내용은 다음과 같습니다.

• 명확한 기술 블로그와 문서는 최종 사용자가 제품을 빠르고 효율적으로 이해할 수 있도록 도와 불만을 줄이고 만족도를 높입니다.

• 철저한 기술 문서 작성은 귀하가 제품과 사용자를 진지하게 생각하고 있음을 보여줍니다. 이는 귀하의 브랜드에 대한 신뢰와 신뢰를 높여줍니다.

• 새로운 최종 사용자가 잘 정리되어 있고 따라하기 쉬운 가이드, 통합 및 문서에 액세스할 수 있다면 제품에 빠르게 익숙해질 수 있습니다.

• 잘 구성된 기술 블로그와 문서는 웹 사이트의 SEO를 개선하여 잠재 고객이 귀하를 더 쉽게 찾을 수 있도록 돕습니다.

• 스타트업이 성장함에 따라 더 많은 직원을 채용해야 합니다. 신입 사원을 효율적으로 교육하려면 훌륭한 기술 문서 작성 및 문서 작성이 필수적입니다.

• 다음은 우수한 엔지니어링 블로그의 몇 가지 예입니다.

• Cloudflare 블로그

• DoorDash 엔지니어링 블로그

• Netflix 기술 블로그

  
  

• 자세한 기술 블로그와 문서는 잠재적인 투자자와 파트너에게 매력적일 수 있는 잘 고려된 제품 및 비즈니스 전략을 가지고 있음을 보여줍니다.

• 기술 블로그 및 문서의 최종 사용자 피드백은 제품을 개선하고 혼란스러운 부분을 식별하는 데 매우 귀중한 경우가 많습니다.

• 잘 작성된 블로그와 문서는 다른 현지 언어로 쉽게 번역될 수 있으므로 더 폭넓은 글로벌 고객에게 다가갈 수 있습니다.

• 뛰어난 기술 블로그와 문서를 보유하는 것은 상당한 차별화 요소가 되어 경쟁업체보다 우위를 점할 수 있습니다.

  
  

좋은 기술 문서 작성 = 유기적인 개발자 마케팅

개발자들은 마케팅을 싫어한다는 평판을 갖고 있지만 반드시 그런 것은 아닙니다.

실제로 개발자는 모든 규모의 기업 내에서 구매력과 존경심을 얻고 있습니다. 좋은 개발자를 찾고 유지하기 어렵기 때문에 고용주는 개발자의 생산성과 행복을 유지하는 데 도움이 되는 도구에 투자하는 것이 중요하다는 것을 인식하고 있습니다.

IDE부터 상위 수준 추상화, 로우 코드 도구를 포함한 GPT와 같은 유료 서비스에 이르기까지 개발자 도구의 다양성이 크게 증가했습니다.

기술 문서 작성은 진정성과 청중 이해에 기반을 둔 성공적인 개발자 마케팅 전략입니다. 스타트업은 개발자와 온라인 및 오프라인으로 시간을 보내 개발자의 요구 사항과 선호도를 파악해야 합니다.

기술 콘텐츠는 진정으로 도움이 되고 교육적이어야 하며 동료 개발자가 만들 때 더 효과적인 경우가 많습니다. 옵션에는 사내 엔지니어, 개발자 옹호자, 커뮤니티 작성 프로그램, 프리랜서 작가, 독립 소프트웨어 엔지니어, 저와 같은 작가가 포함됩니다.

개발자는 X(이전의 Twitter), Hacker News, Reddit 및 LinkedIn과 같은 플랫폼에 있으며 잘 작성된 기술 블로그 게시물을 읽는 것을 좋아합니다.

기술 문서 작성 전략이 돋보이는 이유는 무엇입니까?

하지만 대규모 기술 기업과 스타트업이 개발자에게 다가가는 능력이 점점 더 좋아지고 있다는 점은 인정하겠습니다. 저는 마케팅 개발자로 블로그를 시작하기 전에 실무 소프트웨어 엔지니어이자 기술 리더로 13년을 보냈습니다. 따라서 기술 문서 작성이 스타트업에 큰 자산인 이유에 대한 제 생각은 다음과 같습니다.

B2D 마케팅(“B2D 마케팅”)은 개발자에게 다가가기 위해 고안된 마케팅 이니셔티브를 설명하며, 기술 문서 작성은 진정성 있고, 진정성 있고, 흥미로우면서도 이를 수행하는 가장 좋은 방법 중 하나입니다.

개발자가 일반 소비자보다 접근하기가 더 어렵기 때문에 많은 스타트업이 B2D 기술 마케팅에 어려움을 겪고 있습니다. 스웩, 무료 음식 쿠폰, 무료 티셔츠, 술을 중심으로 한 독점 이벤트와 같은 속임수는 사용할 수 없습니다.

흥미를 가지세요. 글쓰기는 소프트웨어 엔지니어링 개발자로부터 피드백을 받는 가장 빠른 방법입니다.

귀하의 제품으로 멋진 프로젝트를 구축하고 이에 대해 글을 쓰고 공개적으로 공유하여 피드백을 받고 반복하세요.

우리 개발자 모두는 정직함을 높이 평가합니다. 최근에는 Supabase 의 블로그 페이지를 개인적으로 좋아했습니다. 그들은 매우 멋진 블로그를 작성했으며 작성된 콘텐츠를 통해 매우 좋은 성장을 달성했습니다.

스타트업으로서 이는 커뮤니티에서 제품에 대해 정직해야 함을 의미합니다.

많은 대형 기술 고용 개발자 옹호자는 라이브 이벤트에서 자신의 제품을 홍보할 기술적 배경을 가진 사람입니다.

Google/Amazon/Meta/Netflix 와 같은 대형 기술 회사에는 컨퍼런스에서 강연하고, 교육 세션을 진행하고, 회사 제품에 대한 기술 콘텐츠를 작성하기 위해 이러한 사람들로 구성된 팀이 있지만 개발자 옹호자 역할은 대부분의 스타트업에 적합하지 않습니다. 왜냐하면 그들은 빨리 움직여야 했고 불행하게도 많은 개발자 옹호자들은 게으르고 평균 이하의 사람들이기 때문입니다.

스타트업에는 엔지니어링 블로그를 작성하고 사람들이 매일은 아니더라도 매주 방문하고 싶어하는 플랫폼을 구축할 수 있는 고도로 숙련된 기술 엔지니어가 필요합니다.

스타트업은 기술 문서 작성과 문서를 마케팅 도구로 활용해야 합니다.

이미지 출처 - "개발자 관계 현황" - 여기에서 전체 보고서 에 액세스할 수 있습니다 .

효과적인 의사소통에서 기술 문서 작성의 역할

우리는 소프트웨어 개발자를 위한 다양한 유형의 기술 콘텐츠를 작성할 수 있습니다.

• 문서화 는 중요하지만 문서화를 마케팅 채널로 활용하는 스타트업은 거의 없습니다.
• 튜토리얼과 사용 방법 가이드는 최종 사용자가 실제 세계에서 제품을 사용하는 방법을 확인하는 데 도움이 될 수 있습니다.
• 인지도를 높이는 콘텐츠는 유입경로의 최상위 수준을 높이는 것을 목표로 제작되었으며 도달 범위를 확대하기 위해 외부 파트너 사이트에 게시될 수 있습니다. Hashnode, DevTo, HackerNoon 및 DZone은 모두 개발자 콘텐츠를 게시할 수 있는 무료 장소입니다.
• 웹사이트의 블로그 게시물을 통해 독자의 참여를 유도하고 가입률을 높일 수 있습니다.
• 웹사이트나 뉴스레터에 기술 블로그를 작성하는 독립 작가나 수석 엔지니어를 후원하세요.

기술 문서 작성이 명확성과 이해를 보장하는 방법

항상 실제 코드로 시작하여 좋은 예를 작성하면 공개적으로 작성하는 동안 고객 및 투자자와의 신뢰가 구축됩니다.

공개적으로 글을 쓰는 나의 전술:

최근 내 트위터 DM에서 누군가가 나에게 물었습니다. “안녕하세요 Ankur, 저는 당신 블로그의 열렬한 팬이지만 질문이 있습니다. 공개적으로 글을 쓰는 데 어떻게 대처하시나요? 인터넷상의 사람들은 가끔 정말 멍청해요.”

“ 댓글을 끄거나 읽지 마세요 ”라는 조언을 자주 들었지만, 가끔이라도 내 게시물에 대한 인터넷 댓글과 낯선 사람들의 게시물을 수년에 걸쳐 읽으면서 엄청난 지식을 얻었습니다. 사람들은 바보입니다.

항상 실제 사실에 대해 이야기하고 솔직하게 말하세요.

저는 주로 사실에 대해 이야기합니다. 스타트업에 대한 사실이거나 작가로서의 내 경험에 대한 개발자 옹호자입니다. 일반적으로 사실에 대한 사람들의 의견은 꽤 정상적인 경향이 있다고 말하고 싶습니다. 내 실수에 대한 사실에 대해 내가 받는 부정적인 의견의 주요 유형은 다음과 같습니다. 나는 주로 어떤 주제에 대한 나의 지식 수준을 스스로 인식하려고 노력하고, 어떤 것에 대해 확신이 없을 때 “잘 모르겠어…”라고 말함으로써 이 문제를 해결하려고 노력합니다.

실수 편집 및 리팩터링

나는 내 지식의 가장자리에 있는 많은 것에 대해 글을 쓰기 때문에 블로그 게시물에서 실수를 많이 합니다. 사람들이 실수를 지적하면 블로그 글을 수정하고 수정합니다. 일반적으로 나는 실수가 생기면 신속하게 수정할 수 있도록 Twitter나 LinkedIn 타임라인에 블로그 게시물을 게시한 후 몇 시간 동안 컴퓨터 근처에 머물게 됩니다.

기술 지식 격차 해소: 스타트업 개발자 관계 프로그램의 핵심 과제

설문조사 보고서에서는 콘텐츠 개발이 2023년 개발자 관계 실무자에게 가장 중요한 직업 활동으로 언급되었으며, 교육 관련 콘텐츠 개발(55%)과 문서 등 기술 콘텐츠 개발(50%)으로 구분됩니다. 이는 개발자 커뮤니티에 참여하고 교육하는 데 있어 기술 문서 작성 및 콘텐츠 제작의 중요성을 강조합니다.

모든 스타트업이 기술 블로그를 시작하기 전에 물어봐야 할 3가지 질문

기술 블로그를 시작하는 것은 스타트업에게 중요한 단계일 수 있습니다. 의도한 목적을 효과적으로 달성하려면 사려 깊은 접근 방식이 필요하기 때문입니다.

스타트업을 위해 새 블로그를 시작하는 경우 다음 질문을 해보세요.

• 글을 쓰는 목적

• 타겟 청중

• 제작할 콘텐츠의 종류

  
  

브랜드 인지도 제고, 문서 보완, 청중 구축, 사고 리더십 확립 등 블로그의 목표를 식별하는 것이 중요합니다. 둘째, 청중을 이해하고 범위를 좁히는 것은 그에 따라 콘텐츠를 맞춤화하는 데 도움이 됩니다. 마지막으로 튜토리얼, 요약, 사례 연구, 기능, Q&A, 비교, 의견 등 콘텐츠 형식을 결정하면 일관되고 매력적인 블로그를 유지하는 데 도움이 됩니다.

이것이 이 블로그의 전부입니다. 이 주제에 대해 계속해서 글을 쓰고 다음 블로그에서 더 구체적인 기능에 대한 더 많은 통찰력을 공유하겠습니다.

계속 지켜봐 주시기 바랍니다. 그때까지는 여러분이 읽고 싶어할 만한 가장 인기 있는 블로그를 소개합니다.

• 소프트웨어 개발자, 아직 기술 문서 작성을 시작하지 않은 이유는 무엇입니까?
• Amplication을 사용하여 확장 가능한 마이크로서비스를 구축하는 방법
• HarperDB 사용자 정의 기능을 사용하는 방법

다음 게시물에서 기술 문서 작성의 힘에 대해 더 많이 공유할 수 있기를 기대합니다.