"개발자를 위한 글쓰기 가이드"를 읽고

 

테크니컬 라이팅의 목적, 작성 방법 등에 대해 "테크니컬"하게 작성된 책이다.

이해하기 쉽고 정확하게 작성해야 하는 테크니컬 라이팅을 설명하는 이 책 자체가 이해하기 쉽고 정확하게 작성되어 있어서 내용을 받아들이기도 쉬웠고 내게 적용할 부분이 많아서 정말 유용했다.

 

 

Write to express, not to impress

 

테크니컬 라이팅은 잘 표현하여 전달하기 위함이지 감명을 주기 위한 글이 아님을 기억하며 글을 깔끔하게 써보자!

내가 적용해보려 하는 부분들과 글또에서 주워들었던 글쓰기에 대한 내용들을 섞어서 앞으로 기술 블로그를 운영할때 어떤 부분에 중점을 두고 글을 작성해볼지 정리했다.

 

✏️ 글의 구성

두괄식 작성: 핵심 내용을 먼저 작성한다

단락의 내용을 압축한 제목: 구체적이고, 명사의 나열이 아닌 필요한 문장 요소를 가진 제목을 만든다

글의 목적, 독자와 주제를 구체화하기

 

✏️ 문장 표현

간결하게 작성: '~할 것이다', '~하게 됩니다'와 같은 추측성, 완곡한 표현 대신 '~합니다'와 같은 표현을 사용한다

짧게 작성: '진행', '처리' 등, 삭제해도 문장의 의미가 달라지지 않는 단어들은 제거하며, 문장의 길이가 길어지면 나눈다

번역체 쓰지 않기: '~에 대해', '~를 통해' 등의 번역체를 쓰지 않는다. 번역체를 대체할 표현은 분명히 있다 (가장 어렵지 않을까 싶다..)

일관되게 작성: 용어, 문장 끝맺음을 일관되게 작성한다

 

✏️ 글쓰는 행동

퇴고: 검토&재작성 시간이 가장 많이 소요되며, 가장 많이 소요되어야 한다. 그러니 글을 쓸 때에는 부담없이 일단 작성하자

꾸준히 작성: 글쓰는 습관을 만들고, 퇴고할 시간을 갖기 위해서는 꾸준히 글을 작성하는 것이 중요하다

+ 글 한편을 완성하는 시간을 재보기

 

 

 

 

이 글도 나름 테크니컬 하게 써보려 했는데 잘 되었을지 모르겠다..

아무래도 내 블로그를 운영하면 나만의 무언가가 들어가야 한다는 생각 때문인지 나도 모르게 감성적인 글을 작성할 때가 있는 것 같은데, 삽질 경험 글은 아니더라도 일반적인 기술에 대한 내용을 담은 글만큼은 내가 API 문서를 작성한다고 생각하고 테크니컬하게 써봐야겠다고 느꼈다. 또한, 기술적이거나 정보성의 글 뿐만 아니라 회사생활하며 쓰는 모든 글(이메일, 가이드 문서 등)을 이렇게 작성하는 것은 나를 포함하여 읽는 동료들에게도 도움이 많이 될 것 같다.