개발자의 글쓰기 Part 1

개발자의 글쓰기 기술은 단순히 코드를 작성하는 능력을 넘어서는 중요한 역량이다. “개발자의 글쓰기” 책은 이러한 글쓰기 능력을 향상시키는 데 필요한 지침을 제공한다. 이 글에서는 책의 주요 내용을 요약하여 기술 블로그 업로드용으로 재정리해본다.

문장과 단락의 구조화

효과적인 문장 구조는 글쓰기의 기본이다. 간단한 문장 구조로 핵심을 명확하게 전달하고, 필요에 따라 부가 설명을 추가하는 방식이 이상적이다. 특히, 첫 문장의 주제를 소제목으로 활용하면 문단 구성이 자연스러워진다.

서술식, 개조식, 도식의 활용

• 서술식은 줄거리가 있는 설명이나 이야기에 적합하다.
• 개조식은 여러 항목이나 내용을 나열할 때 유용하다.
• 도식은 항목 간의 관계를 명확하게 표현할 때 사용된다. 글쓰기의 형식은 내용을 전달하는 방식에 따라 달라진다. 예를 들어, 개조식은 릴리즈 문서나 장애 보고서 작성에 적합하며, 서술식은 개발 가이드 문서에 주로 사용된다.

문단의 위계

비즈니스 문서는 명확한 위계를 가져야 한다. 문서에 위계가 있으면 독자는 문서의 체계를 빠르게 이해할 수 있으며, 이는 읽는 시간을 단축시킨다.

띄어쓰기와 문장 부호

한글 띄어쓰기는 종종 어렵게 느껴질 수 있다. 기본적으로 조사, 순사, 숫자, ‘하다’, 기호는 붙여쓰고, 나머지는 띄어쓴다. 비즈니스 문서에서 큰따옴표와 작은따옴표의 사용도 주의가 필요하다. 큰따옴표는 책의 제목이나 글의 이름을 나타내는 데 사용되며, 작은따옴표는 소제목, 상호, 법률, 규정 등을 나타내는 데 사용된다.

영어 단어 선택과 외래어 표기법

정확한 단어 선택은 의미를 명확하게 전달하는 데 중요하다. 예를 들어, ‘get’, ‘retrieve’, ‘acquire’, ‘fetch’는 모두 ‘가져오다’라는 의미이지만, 각각의 사용 상황에 따라 달라진다. 마찬가지로, ‘set’, ‘init’, ‘create’, ‘register’도 각기 다른 상황에서 사용된다. 이처럼 적절한 단어 선택은 글의 의도와 명확성을 향상시킨다.

개발자의 글쓰기는 단순히 코드를 넘어서는 소통의 도구이다. 이 책에서 제시한 글쓰기 전략과 기술을 통해, 개발자는 자신의 아이디어와 생각을 더 명확하고 효과적으로 전달할 수 있다. 글쓰기는 개발자에게 있어서 단순한 기술 이상의 가치를 지닌다는 것을 잊지 말자.