개발자의 글쓰기 - 테크니컬 라이팅(technical writing)

Development/기타

Jin’s 2022. 2. 7. 15:44

개발자로 일하면서 글을 작성해야 하는 경우가 많았다.

개발을 다한 후 다른 동에게 인수인계나 공유(발표)를 해야 할 때,

솔루션 회사를 다녔을 땐 개발 가이드를 작성해야 했었고,

관리자 화면을 개발하면 사용자 가이드를 적어야 하는 경우들이 있다.

이러한 상황에서 테크니컬 라이팅을 알고 정리를 했다면 좀 더 효율적이지 않았을까 싶다.

1. 테크니컬 라이팅이란?

글쓰기 기법으로 기술 정보를 정확하게 전달하고 효과적으로 전달하여 위한 문서 작성 기술이다.

2. 테크니컬 라이팅 원칙

1) 명확성

- 독자가 핵심 문장이 모호하지 않아 혼란이 없도록 해야한다.

- 내용을 전달할 독자를 제대로 파악해야 한다.

2) 간결성

- 신속하고 정확하게 정보를 이해하도록 써야 한다.

- 불필요한 단어 쓰지 않아야 한다.

3) 정확성

- 정확한 정보, 사실만 전달해야 한다.

4) 일관성

- 일관된 용어로 작성한다.

3. 개발자로 일하면서 실제로 사용될 곳

개발자 문서, GitHub, 인수인계, 기술 블로그, 사용자 가이드, 장애 보고서 등

[ 참고 ]