1,182 판독값

소프트웨어 개발자, 아직 기술 문서 작성을 시작하지 않은 이유는 무엇입니까?

~에 의해 Ankur Tyagi12m2023/10/20

너무 오래; 읽다

무엇이든 가르치고 글을 쓰는 것은 그것에 대해 배우는 가장 좋은 방법이며, 새로운 라이프스타일을 시작하는 것은 쉬운 일이 아닙니다.

featured image - 소프트웨어 개발자, 아직 기술 문서 작성을 시작하지 않은 이유는 무엇입니까?

‘a programmer typing on his keyboard’ Image created by HackerNoon AI Image Generator

블로그는 여러 가지 이유로 귀하뿐만 아니라 기술 분야의 다른 소프트웨어 개발자에게도 유용한 자료입니다.

기술 문서 작성은 소프트웨어 개발자가 소프트웨어 엔지니어링 분야의 다른 소프트웨어 개발자와 기술 지식/경험을 공유하는 데 도움이 됩니다.

기술 문서 작성은 특정 작업을 수행하거나 특정 목표를 달성하는 데 필요한 사람들에게 복잡한 정보를 전달하는 것과 관련된 글쓰기 분야입니다. 이 때문에 기술 문서 작성은 종종 " 복잡한 것을 단순화하는 것 "으로 정의됩니다.

또한 작성 중인 주제에 대한 이해도를 높이고 기술 전문 지식을 명확하게 보여줍니다.

기술 문서 작성의 가장 독특한 점은 훌륭한 미래 기회(기술 분야의 원격 근무, 프리랜서 글쓰기 계약 또는 대형 기술 회사 웹사이트의 게스트 포스트 기회 등)를 생성할 수 있을 뿐만 아니라, 이를 구축하는 데 도움이 될 수 있다는 것입니다. 결국 소프트웨어 개발자로서의 경력을 쌓는 데 도움이 되는 온라인 존재입니다.

때로는 특정 주제에 대한 정보를 찾을 때 블로그 게시물을 다시 읽어보곤 합니다.

소프트웨어 엔지니어링 경력에서 흥미로운 일을 했지만 그 일을 혼자만 간직하고 있다면 큰 기회를 놓치고 있는 것입니다.
글쓰기를 시작하면 인터넷에서 아이디어를 홍보하는 효과적인 방법입니다.
“언제 발견했으면 하는 블로그를 작성하세요… https://t.co/PcXR0fL9QF
— Ankur💻🎧💪(@TheAnkurTyagi) 2023년 10월 3일

또한, 다른 사람의 학습을 돕고 싶고, 오픈 소스 프로젝트에 참여하고 다른 사람에게 참여 방법을 보여주는 것을 좋아하거나, 글을 통해 복잡한 아이디어를 이해하기 쉬운 방식으로 설명하는 데 만족을 찾는다면 기술 문서 작성이 적합합니다. 너.

이 기사에서는 프로그래밍과 글쓰기가 어떻게 통합되어 개발자 기술을 향상시킬 수 있는지 설명하는 것을 목표로 합니다. 응, 글쓰기! 나는 진심으로 우리 모두가 어느 정도의 글쓰기 능력을 갖고 있다고 생각합니다. 저는 여러분이 더욱 능숙한 개발자이자 커뮤니케이터가 되는 데 도움이 되는 글쓰기 팁, 조언, 예시를 제공하기 위해 왔습니다.

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

기술 문서 작성은 사용자, 동료 개발자 또는 관리자가 기술 제품이나 기술 또는 아이디어를 이해할 수 있도록 명확하고 자세한 지침을 제공하는 것입니다.

기술 작가는 이러한 튜토리얼과 기술 문서를 작성하는 사람입니다.

기술 문서 작성은 다음과 같습니다.

두 기술 SaaS 간의 사용자 가이드 또는 통합 방법
온라인 지원 기사
주로 연구나 실험을 수행한 후 특정 주제에 대한 정보를 제공하는 기술 보고서입니다 . 과학 및 공학 분야에서 흔히 볼 수 있습니다.
기술 제안서 이 문서는 계획, 아이디어 또는 프로젝트를 명확하고 설득력 있게 설명합니다. 이는 승인, 자금 조달 또는 협력을 찾는 데 사용됩니다.
프로그래머를 위한 내부 메타물질과 개발자를 위한 API 문서 .

본질적으로 기술 작가는 독자가 특정 목적에 맞게 해당 정보를 효과적으로 적용할 수 있도록 기술적인 세부 사항을 전달합니다.

기술 문서 작성을 시작하고 소프트웨어 개발/프로그래밍 또는 기술 분야에서 배운 내용에 대해 글을 쓰려고 하지만 아직 첫 번째 블로그를 작성하지 않은 경우 첫 두 섹션에서 가장 큰 가치를 찾을 수 있습니다. 이 블로그 게시물에서는 기술 작가나 블로거로 시작하는 방법과 블로그를 확장하는 방법에 대해 이야기합니다.

블로그의 나머지 부분은 소프트웨어 개발자 작가로서 성공하고 직장에서 성공하고 경력을 발전시키는 데 필요한 지식 격차를 메우는 데 유용할 것입니다.

“꿈이 있으면 평생을 공부하고, 계획하고, 준비하는 데 시간을 투자할 수 있습니다. 당신이 해야 할 일은 시작하는 것입니다.”
—드류 휴스턴

글쓰기는 어디에나 있다?

사람들이 코딩을 배우기 위해 사용하는 상위 2개 온라인 리소스는 기술 문서와 Stack Overflow이며, 블로그가 상위 3개를 차지합니다.

사람들이 기술에 대해 스스로 배울 수 있도록 하는 세 가지 요소에는 명확한 문서, 솔루션을 제공하는 활발한 커뮤니티, 빈번한 게시물이 포함됩니다.

개발자는 방법 비디오, 서면 튜토리얼, 책, 포럼을 포함한 다양한 추가 소스를 중요하게 생각하며 자신의 학습 스타일에 가장 적합한 소스와 형식을 함께 모았습니다.

팀 내에서나 온라인에서 자신의 아이디어를 명확하게 표현할 수 있는 능력은 많은 개발자가 어렵게 생각하는 귀중한 기술입니다. 코드 작성을 포함하지 않고 매일 얼마나 많은 글을 쓰는지 생각해 보세요. 이 스킬은 초능력입니다.

Slack 채팅, 이메일, 내부 개발자 문서, RCA 초안, 추가 정보, 코드 주석, Git 커밋 메시지, 풀 요청, 코드 검토 주석, 연간 성과 피드백, 회의 노트 등과 같은 다양한 형태의 글쓰기에 참여합니다.

글쓰기를 마스터하는 것은 소프트웨어 개발자에게 매우 중요합니다. 부적절한 글쓰기 능력은 특정 수준 이상으로 경력 발전을 방해할 수 있습니다. 많은 엔지니어들은 나중에 "소프트 스킬이 코드만큼 중요하다"는 사실을 깨닫게 됩니다.

젊은이들: 매일 30분씩 글을 쓰고 매달 온라인에 2~3개의 블로그를 게시하면 소프트웨어 엔지니어링 경력이 크게 향상되고 기술 분야에서 미래에 더 나은 기회를 얻게 될 것입니다. 그러나 실제로 이렇게 할 수 있는 개발자는 거의 없습니다. 장기간. https://t.co/damIJ5gXys
— Ankur💻🎧💪(@TheAnkurTyagi) 2023년 10월 4일

개발자에게 글쓰기가 중요한 이유

JavaScript, TypeScript, PHP, Go, Java 등 다양한 프로그래밍 언어가 있으며 여러분은 그 중 많은 언어에 능숙할 수도 있습니다.

우리가 기술 분야에서 더 높은 품질의 코드를 생성하려고 노력할 때, 일상 언어로 효과적으로 작성하고 의사소통하는 능력은 소프트웨어 엔지니어링 분야에서는 과소평가될 수 있는 중요한 기술이 됩니다.

소프트웨어 엔지니어링은 단지 코드에 관한 것이 아닙니다. 사람 + 코드에 관한 것입니다.
소프트웨어 엔지니어로서 더 나은 작가가 되는 방법

엔지니어가 코드에 대한 자신의 생각을 표현하는 방법은 코드 자체만큼 중요할 수 있습니다. 이 문제에 대한 귀하의 입장에 관계없이, 우리는 우리의 말이 코드의 효율성을 향상시키거나 방해할 수 있는 힘을 가지고 있음을 만장일치로 인정할 수 있습니다.

글쓰기는 행운의 표면적을 늘리는 데 도움이 될 수 있습니다.

L = D * T, 여기서 L은 행운이고, D는 행하고, T는 말하는 것입니다.
– 제이슨 C. 로버츠

기술 문서 작성의 6가지 주요 이점

더 깊은 수준에서 개념을 이해하는 데 도움이 됩니다.

설명하는 개념을 조사해야 하며, 이를 통해 다양한 아이디어, 응용 프로그램 및 문제점을 접할 수 있습니다.
개념은 다른 사람에게 설명할 때 뇌에 더 잘 남습니다.
다른 사람을 위해 정보를 구조화하고 제시함으로써 지식의 공백을 발견하는 경우가 많습니다. 결과적으로, 이는 개발자 경력에서 더 빠르게 발전하는 데에도 도움이 됩니다.
기술 작가는 평생 학습자입니다. 각각의 새로운 기술 블로그를 통해 연구하고 작성하면 해당 주제에 대한 전문가가 되기 때문입니다.
글쓰기는 또한 사용자 공감에 대한 더 깊은 이해를 촉진합니다. 자신의 관점에만 의존하기보다는 독자나 제품 사용자의 관점과 감정에 더 집중하도록 유도합니다.
다음은 몇 가지 추가 이점입니다.

또한, 다양한 단체에 기여함으로써 테크니컬 라이터로서 수입도 창출할 수 있습니다. 기술 작가에게 돈을 지불하는 멋진 회사를 확인해 보세요.

대학에서는 호스텔에서 남을 가르치며 공부했습니다.

무언가를 설명하거나 가장하는 것은 지식을 일관되게 정리하고 지식의 격차를 드러내며 알고 있는 부분을 강화하도록 강요합니다.

배우는 가장 좋은 방법은 가르치는 것이며, 글쓰기는 모든 개발자에게 훌륭한 자산입니다.

단순히 주의를 기울이는 대신 사람과 기업이 당신에게 보답합니다. 기술 블로그 게시물을 작성하면 즉각적인 피드백을 받을 수 있습니다. 귀하의 기술 문서 작성은 소문을 퍼뜨리고 훨씬 더 흥미로운 기회의 문을 여는 데도 도움이 됩니다.

당신이 좋아한다면 기술 문서 작성 분야에서 수익성 있는 직업을 가질 수도 있습니다. 요즘 제가 블로그 에 쓰는 거의 모든 내용은 제가 더 잘 이해하려고 노력하는 개념입니다. 글로 설명할 수 없다면 제대로 이해하지 못한 것입니다.

기술 문서 작성의 예는 무엇입니까?

기술 문서 작성자로서 귀하의 역할은 복잡한 기술 정보를 접근 가능하고 사용자 친화적인 언어로 번역하는 것입니다. 기술 문서 작성에는 단계별 튜토리얼 및 포괄적인 가이드 작성을 포함하여 다양한 형식이 포함됩니다.

주요 목표는 내부 팀 구성원이든 최종 사용자이든 제품이나 서비스의 기술적 측면에 대한 이해를 촉진하는 것입니다.

이를 염두에 두고 다음 기술 문서 작성 예시를 통해 명확한 이해를 얻으실 수 있습니다.

SuperTokens 검토 – Auth0, Firebase Auth 및 AWS Cognito에 대한 오픈 소스 대안.

이것은 슈퍼토큰 검토의 매우 간단한 예이며 "슈퍼토큰"이 왜 좋은 사용자 인증인지에 대한 것입니다.

Medusa를 사용하여 Next.js 전자상거래 상점을 만드는 방법

이는 앱 구축과 함께 튜토리얼을 구축하는 방법에 대한 아주 좋은 예입니다. 이 블로그에서는 Shopify의 오픈 소스 대안인 Medusa를 통해 전자상거래 상점을 구축하기 위한 단계별 가이드를 공유했습니다.

MindsDB 및 OpenAI를 사용하여 LLM을 배포하는 방법

이 가이드에서는 MindDB 및 OpenAI를 사용하여 LLM을 배포하는 방법을 공유했습니다.

Supabase에서 HarperDB로 데이터베이스를 마이그레이션하는 방법

데이터베이스를 Supabase에서 HarperDB로 마이그레이션하는 방법에 대한 전체 튜토리얼

5- 제품 문서

제품 설명서에는 다른 개발자 도구를 효과적으로 사용하고 통합하는 방법에 대한 지침이 포함되어 있습니다.

제품 문서를 작성하려면 우수한 기술 작성 기술과 조직적 지식이 필요합니다. 이는 연구, 시각화 및 다양한 청중과 연결하는 능력에 있어 높은 수준의 기술을 요구하는 기술 문서 작성에 포함되는 몇 가지 예일 뿐입니다.

팁 - '제목이 독자의 관심을 사로잡는가?'라고 자문해 보세요. 그렇다면 그들은 서문을 자세히 살펴본 다음 '이 전체 내용에 시간을 투자할 가치가 있는가?'라고 결정할 것입니다. 기술 관련 게시물에서 제가 자주 목격하는 실수 중 하나는 소개가 너무 많거나 반대로 소개가 너무 적다는 것입니다.

정확하게 작성된 단락은 기술 블로그 게시물의 무대를 효과적으로 설정할 수 있습니다.

테크니컬 라이터로 시작하려면 어떻게 해야 하나요?

지금까지 "기술 문서 작성 또는 블로깅"에 관해 제가 받는 가장 일반적인 질문은 시작하는 방법에 관한 것입니다.

인생에서, 무언가를 하고 싶고 되고 싶은 사람이 되는 데 가장 큰 장애물은 시작하는 것 같습니다.

가장 큰 적은 '자기 의심'입니다. pic.twitter.com/fw1691QRSY
— Ankur💻🎧💪(@TheAnkurTyagi) 2023년 8월 10일

새로운 운동 요법을 시작하든, 마라톤 훈련을 시작하든, 사업을 시작하든, 책을 쓰든, 더 구체적으로 이 경우에는 글쓰기 등 가장 어려운 부분은 항상 시작하는 것입니다.

무엇을 해야 할지 토론하면서 수많은 시간을 낭비하는 것은 쉽고 유혹적입니다.

"쓰기"를 시작하는 것보다 "읽고" "읽고" "공부"하는 것이 훨씬 쉽습니다.

하지만 비밀은 한 번에 한 단계만 수행하면 된다는 것입니다.

소프트웨어 엔지니어링 경력에서 하나 이상의 복합 자산을 구축하십시오.

– 블로그 시작 – 뉴스레터 시작 – YT 비디오 녹화 시작 – 팟캐스트 시작 – 네트워크 구축 시작
빌드, 게시 및 반복
미래의 기회는 인터넷에서 당신을 기다리고 있습니다
참조 @TheAnkurTyagi
— Kap.ts(@Kaperskyguru) 2023년 2월 17일

그리고 주위를 둘러보세요. 소프트웨어 엔지니어링 분야의 대부분의 개발자는 연중무휴로 코드를 작성하지 않습니다. 우리 대부분은 매일 다른 일을 하면서 많은 시간을 보냅니다.

그것은 포함:

회사 또는 고객 내 팀 전반에 걸쳐 새로운 기능을 시연합니다.
제품의 새로운 기능이나 기존 기능을 문서화합니다.
JIRA 티켓 관련 업데이트.
새로운 기능을 지원하기 위해 백로그 작업을 생성합니다.

물론, 화장실/점심시간을 보내고 트위터를 스크롤할 시간도 항상 있습니다 😉

그러니 지나치게 생각하지 마세요. 그냥 시작하세요

“글쓰기는 농구를 배우는 것과 같습니다.”
– 데이비드 페렐

성공적인 작가가 되고 기회를 찾으려면 3가지 기술을 갖추어야 합니다.

코딩
글쓰기
영어

네, 글쓰기를 시작하기 전에 먼저 영어의 시제, 철자법, 기본 문법을 포함하여 영어를 이해해야 합니다.

독자들은 문법 오류와 잘못된 단어 선택으로 가득 찬 기사를 읽고 싶어하지 않습니다.

기술 산업에서 영어는 전 세계 소프트웨어 개발자, 엔지니어 및 기타 기술 전문가 간의 의사소통을 위한 사실상의 언어가 되었습니다. 문서화에 사용되는 언어, 프로그래밍 언어, 개발에 사용되는 도구입니다.

아이디어를 간단하고 명확하게 전달하는 방법을 배우세요

기술적 기능을 구현하는 방법을 안다고 해서 반드시 다른 사람에게 프로세스를 설명할 수 있다는 의미는 아닙니다.

좋은 교사가 되려면 공감과 대상 청중에게 적합한 방식으로 정보를 전달하는 기술이 필요합니다.

여섯 살짜리 아이에게 설명할 수 없다면 뭔가를 이해하지 못한 것입니다.
아인슈타인, 앨버트

뛰어난 작가가 되기 위한 완벽한 전략은 없습니다. 그렇다면 내가 왜 이 주제를 논의하고 있는지 궁금할 것입니다. 처음부터 이를 바로잡는 것이 중요하기 때문이다.

“전략을 찾지 마세요. 글쓰기에서 당신의 독특한 목소리를 찾고 당신의 스타일을 구축하세요.”

당신이 알아야 할 유일한 글쓰기 꿀팁.

기술이 적을수록 더 좋습니다. 저는 90%의 시간을 React로 작업합니다.
처음으로 글을 쓰는 경우에는 이해할 수 있도록 더 많은 시간을 투자하세요.
글을 제대로 쓰지 마십시오.
준비를 멈추고 행동을 시작하십시오.

AI 시대에 뛰어난 작가가 되는 방법:
다음 블로그 게시물을 작성하기 전에 ChatGPT에 해당 주제에 대한 게시물을 작성하고 이미 인터넷에서 사용할 수 있는 일반적인 내용이 무엇인지 보여달라고 요청하세요. 그렇게 하면 그런 말을 하지 않고 청중에게 중요하고 고유한 내용을 작성할 수 있습니다.
— Ankur💻🎧💪(@TheAnkurTyagi) 2023년 2월 16일

청중을 이해하려면 글을 쓰기 전에 다음 질문을 하십시오.

당신의 독자는 누구입니까?
그들은 Google에서 무엇을 검색하며 어떤 문제에 직면하고 있나요?
현재 어떤 블로그를 읽고 있나요?
그들은 어떻게 읽을 것인가?

블로그 게시물 아이디어를 생각해내는 방법

인터넷 검색과 머리 긁는 데 몇 시간을 소비하지 않도록 기사를 작성하세요.
새로운 것을 배울 때마다 그것을 어떻게 배웠는지, 무엇을 배웠는지 적어보세요.
자신의 분야, 관심분야, 직업에 관한 이야기를 작성해 보세요.
좋아하는 블로거의 블로그 게시물 중 재미있다고 생각되는 게시물을 선택하고 새로운 관점에서 동일한 주제를 탐색하거나 비슷한 각도에서 다른 주제를 다루세요.

뭔가를 구글링했을 때 찾았으면 좋았을 블로그 게시물을 작성해 보세요.
— Ankur💻🎧💪(@TheAnkurTyagi) 2023년 3월 20일

참고 - 소프트웨어 엔지니어링 경력에서 흥미로운 일을 했지만 그 일을 혼자만 간직하고 있다면 큰 기회 창출 기회를 놓치고 있는 것입니다.

아이디어를 효과적으로 홍보하려면 글쓰기를 통해 인터넷을 탐색하는 것이 가장 좋습니다.

기술 관련 게시물과 튜토리얼을 작성하기에 좋은 장소가 있습니다. 아직 배울 시간이 없는 전문가를 위해 글을 쓰고, 그들이 이미 알고 있는 내용과 다시 연결해 보세요. 예를 들어 jQuery를 아는 사람에게 최신 JS 기술을 설명하는 경우입니다.
— 레이첼 앤드류(@rachelandrew) 2019년 2월 20일