feat: 간결하게 글을 작성해야 하는 이유

_posts/etc/2023-10-14-TechnicalDocument.md

@@ -0,0 +1,78 @@
+---
+published: true
+title: "공학작문 - 짧은 내용으로 좋은 기술 문서를 작성할 수 있는 방법"
+categories:
+  - etc
+---
+
+좋은 기술 문서를 작성하기 위해서는 글의 형식에 맞게 최대한 간결하게 작성해야 합니다. 공학작문 수업을 듣기전 평소 글 쓰기 습관은 주제와 관련된 내용을 최대한 자세하고 적으려고 했고 자연스럽게 글의 양은 늘어났습니다. 하지만 수업을 듣고 나서 저의 글 쓰기 습관은 반대가 되었습니다. 아래에서 기술 문서를 최대한 간결하게 작성해야 하는 이유와 기술 문서를 작성하는 방법과 평가 방법에 대해서 알아보도록 하겠습니다.
+
+</br>
+</br>
+
+## 기술 문서는 최대한 간결하게 작성한다.
+기술 문서는 최대한 간결하게 작성해야 합니다. 시선 추적 연구에 따르면, 우리가 하나의 컨텐츠를 읽는데 평균 "26초"를 소비한다는 결과를 발표했습니다. 또, 우리 뇌가 글이 마음에 드는지 결정하는 시간은 고작 "0.017초"밖에 걸리지 않습니다. 생각해보면 제가 글을 읽을 때도 목차가 없어 글의 구조를 한눈에 파악하기 어렵거나 문제 해결을 위한 코드가 아니라 말로 적었다면 바로 뒤로가기를 눌렀습니다. 
+
+독자는 우리가 쓴 글을 그저 훑어보거나 건너뛸 거라는 사실을 받아드리고 모든 단어와 문장을 간결하고 중요하게 만들어야 합니다. 독자는 "그것이 왜 중요한지" 알고 싶을 뿐입니다.
+
+</br>
+</br>
+
+
+## 글 평가 방법
+1. 제목이 내용을 기대하게 하는가?
+가상의 독자를 설정하고 독자들이 기술 문서의 제목을 보고 기대하도록 작성해야 합니다.
+
+2. 필자의 주장 요지가 분명히 인식되는가?
+필자의 주장 요지를 분명히 적어 앞으로 글이 어떻게 전개될지 독자들에게 알려야 합니다.
+
+3. 나의 생각과 일치하는지 반대인지 빠르게 확인할 수 있나? -> 결론
+필자의 주장과 독자의 주장이 일치하는지 반대인지 확인할 수 있어야 합니다. 이 부분은 결론에 해당합니다.
+
+4. 다른 사람에게 요약해서 이야기할 수 있나?
+필자의 주장을 형식과 구성에 맞게 요약해서 글을 작성해야 합니다.
+
+5. 글의 내용에 해당하는 예를 들 수 있나?
+글의 내용에 해당하는 코드 예시를 들어야 합니다. 우리가 설정한 대부분의 독자들은 문제 해결을 위한 개발자입니다. 소스 코드로 문제를 빠르게 해결할 수 있게 구체적인 소스 코드를 제공해야 합니다.
+
+</br>
+</br>
+
+## 기술 문서를 위한 글쓰기 연습
+</br>
+
+### 제목, 서론, 본론, 결론
+- 좋은 제목
+좋은 제목으로 독자들의 주목을 바로 받을 수 있게 작성해야 합니다.
+
+- 문단과 문단의 구조
+서론을 통해서 문단과 문단을 어떻게 연결할지 고려해야 합니다.
+
+- 명확한 결론
+기술 문서가 주장하는 바를 분명하게 전달해야 합니다.
+
+- 구체적인 사실, 새로운 사실
+구체적인 사실과, 새로운 사실을 전달해야 합니다. 연구 보고서에 예상치 못한 결과로 새로운 사실을 알 수 있습니다.
+
+</br>
+
+### 취재 및 정리
+자료 수집시 Blind reference를 주의 해야 합니다. 반드시 reference site를 확인 후 인용하도록 합시다. 그리고 취재의 범위에 한계를 설정해야 합니다.
+
+### 글 쓰기
+도구를 활용해 중간 중간 글을 저장하고 문단을 적절히 나눠야 합니다. 그리고 마지막으로 맞춤법에 어긋나지 않도록 글을 작성해야 합니다.
+
+### 퇴고 및 정리
+자신이 쓴 글을 동료에게 보여줘 평가와 리뷰를 활용해야 합니다. 그리고 매번 강조하지만 글의 형식을 준수해야 합니다.
+
+
+</br>
+</br>
+
+## 마치며
+기술 문서를 작성할 때 최대한 간결하게 써야하는 이유에 대해서 알아봤습니다. 우리의 글 읽는 경험을 뒤돌아 봤을 때 글을 선별하고 읽는 시간은 고작 "30초"밖에 되지 않습니다. 최대한 글의 형식에 맞게 작성하고 리뷰나 퇴고를 통해 간결하게 작성하도록 합시다. 마지막으로 조환규 교수님의 말을 인용하면서 마치겠습니다.
+
+> “글은 쓰는 게 아니라 빼는 거다. 문법에 맞고, 문장에 군더더기가 없는 게 좋은 글이다. 부사, 형용사,빼도 말이 되면 어떤 거든 무조건 빼자. 더는 뺄 수 없을 때까지.”
+
+## 참조 문서
+[공학작문및발표 PPT](https://docs.google.com/presentation/d/1wHxuNx9QSKNZLGnfPFd5KR78104tD5e4kUfhGB_Avjg/edit#slide=id.p1)