✍️ 개발자가 글을 써야 하는 이유

개발자는 직급이 올라갈수록 글을 써야 하는 일이 늘어납니다. 인스타그램 스태프 엔지니어 Ryan Peterman의 포스팅을 바탕으로 개발자가 글을 써야 하는 이유 세 가지를 정리해 보았습니다.


1️⃣ 글쓰기는 업무의 중요한 부분이다.


개발자가가 하는 거의 모든 일은 글쓰기를 필요로 합니다. 작게는 기술적인 질문을 하거나 코드 리뷰에서 의견을 내는 것부터 시작해서, 팀에 필요한 가이드를 쓰거나 설계 문서를 작성하는 것까지 글쓰기가 필요한 곳은 생각보다 많습니다. 개발은 혼자서 하는 게 아니라 여럿이서 협업하는 작업이기 때문이죠. 따라서 협업에 꼭 필요한 글쓰기 실력을 늘린다면, 개발 업무 또한 보다 잘할 수 있습니다.


2️⃣ 개인과 팀의 업무 효율을 높일 수 있다.


동료 중 기록을 기가 막히게 하는 친구가 있었습니다. 그 동료는 자주 사용되는 명령어, 코드 관련 정보, 시스템 다이어그램까지 상세히 기록해서 팀 위키 페이지에 공유했는데요, 이렇게 문서화가 잘 되어있으니 팀원들이 별도의 도움 없이도 빠르게 업무를 진행할 수 있었습니다. 이처럼 글쓰기에는 개인뿐 아니라 팀 전체의 업무 효율을 높일 수 있는 큰 영향력이 있습니다.


3️⃣ 개인의 사고력을 향상시킨다.


자신의 생각을 글로 기록하는 과정에서 우리는 생각을 일관되고 논리적인 포인트로 정제시키게 됩니다. 글을 쓰고 이를 더 간결하게 요약하면서 내용을 더 깊게 이해하게 되고, 이 과정은 우리의 사고력을 향상시킵니다. 또한 글을 쓰면서 엣지 케이스를 발견하기도 하고, 새로운 아이디어를 얻기도 합니다. 이처럼 글쓰기는 핵심적인 사고가 필요할 때 아주 효과적인 툴입니다.

Why Engineers Need To Write

www.developing.dev

Why Engineers Need To Write

다음 내용이 궁금하다면?

또는

이미 회원이신가요?

2023년 10월 22일 오후 10:56

 • 

저장 64조회 8,344

댓글 0

    함께 읽은 게시물

    간만에 개발 떡밥이(신난다) 이번엔 제가 소수 입장에 있는 ORM이군요. 후후..


    저는 몇몇 사건을 통해 ORM 반대주의자가 된 사람인데요.


    ... 더 보기

    어제 출시된 따끈따끈한 ChatGPT Codex를 실제 프로젝트 레포에 써 보았습니다.


    테스트가 있으면 스스로 테스트도 실행하고, 만든거 스스로 실행해보면서 버그도 수정하고 하는게 기특하긴 합니다.


    ... 더 보기

    < 💡 Spring Rest Docs 로 Swagger API 문서 관리 자동화 > 💬 Spring Rest Docs 란? Spring REST Docs 는 RESTful 서비스의 문서화를 도와주는 도구이다. 문서 작성 도구로 Asciidoctor 를 기본적으로 사용하며, 이것을 통해 HTML 문서를 생성한다. 필요한 경우 Markdown 문법을 사용하도록 변경할 수 있다. RESTful API를 문서화 할때 중요한 포인트는 API 에서 필요한 HTTP 요청과 응답의 리소스를 설명하는 것인데 Spring REST Docs 를 사용할 경우 테스트 코드를 작성하여 이러한 리소스와 HTTP 요청/응답에 대한 세부 내용을 문서화하는데 편리한 기능을 제공한다. 💬 Swagger 란? RESTful API 를 약속된 규칙에 따라 json 이나 yaml 형식으로 문서화한 Open API Specification(OAS) 라는게 있는데 이 문서를 관리하기위한 목적으로 만들어진 프레임워크다. API 문서 자동화 도구로 Spring REST Docs 의 비교군으로 자주 등장하는데 Spring 을 사용할 경우 서비스 코드에 어노테이션... 더 보기

    [NHN FORWARD 2020] MSA 환경에서 API 문서 관리하기: 생성부터 배포까지

    www.youtube.com

    [NHN FORWARD 2020] MSA 환경에서 API 문서 관리하기: 생성부터 배포까지

    🎙️NotebookLM 해설 - 진격의 AI, 개발자는 자멸할까?

    G

    ... 더 보기

    - YouTube

    youtu.be

     - YouTube