기술 보고서 잘 쓰는 법
인공지능에게 질문하다
요즘 ChatGPT가 난리긴 난리인가 봅니다. 블로그에 ChatGPT를 이용하시는 분들도 많으신 거 같더라고요. 완전히 자동화해서 이용하기도 하는데 저는 전문 블로거는 아니니 그냥 긁어다 필요한 글만 추가해 보려고 합니다.
기술보고서 잘 쓰는 법을 질문했는데, 어떤 내용들을 포함해야 하는지 답변을 주더군요. 그래서 자세한 내용을 원했더니 조금 풀어주긴 했습니다. 항목별로 또다시 질문하면 점점 더 깊은 답변을 추출해 낼 수 있을 것 같더라고요.
기술 보고서가 포함해야 할 내용_ with ChatGPT
기술 보고서는 특정 기술적 행위에 대한 결과를 알리는 문서입니다. 어떤 기술을 연구/개발하거나 활용한 결과를 상급자, 동료, 대중 등에게 알리는 것이죠. 따라서 보고서는 보고서를 보는 사람의 입장에서 작성해야 합니다. 똑같은 내용을 설명하더라도 대상에 따라 한 페이지가 될 수도 있고 책 한 권이 될 수도 있는 것이죠.
ChatGPT의 답변 내용을 정리하고, 제가 추가로 작성한 내용은 다른 색으로 표기해 두었습니다.
■ 메인 페이지 (Title page): 여기에는 보고서 제목, 작성자 이름 및 제출 날짜 포함
- 제목은 명확하고 간결해야 하며, 보고서의 내용을 정확하게 반영해야 한다.
- 저자의 이름과 제출 날짜도 포함되어야 한다.
■ 요약 (Abstract): 보고서의 주요 결과와 결론에 대한 요약으로, 한 페이지를 넘지 않게
- 간략한 요약으로, 보통 한 페이지를 넘지 않는다.
- 보고서의 주요 결과와 결론에 대한 명확한 개요를 제공해야 한다.
- 보고서를 다 쓴 후에 요약본을 작성하는 것이 효율적으로 요약할 수 있다.
※ 보고서를 검토받을 때 주로 요약 페이지를 먼저 확인하므로 요약본 작성이 매우 중요하다고 할 수 있습니다.
■ 소개/개요 (Introduction): 주제에 대한 배경 정보를 제공하고 보고서의 목적을 설명
- 주제에 대한 배경 정보를 제공하고 보고서의 목적을 설명해야 한다.
- 서론은 또한 보고서가 다루려는 연구 질문이나 문제를 진술하고 보고서의 구조에 대한 개요를 제공해야 한다.
※ 개요에는 기술적 행위를 하게 된 배경, 목적 및 의의, 목표, 필요성 등이 작성됩니다. 방향성 없는 업무는 삽질이나 다름없기 때문에 보고의 대상이 되는 행위가 왜 일어나게 되었는가를 명확히 설명할 수 있어야 합니다.
■ 방법 (Methods): 장비 또는 재료를 포함하여 사용되는 연구 방법에 대한 설명
- 장비 또는 재료를 포함하여 사용된 연구 방법에 대한 자세한 설명을 제공해야 한다.
- 또한 데이터가 수집된 방법과 연구의 한계를 설명해야 한다.
※ 기술을 개발한 방법 혹은 사용한 방법을 설명해야 한다는 의미입니다.
■ 결과 (Results): 데이터 및 관련 분석을 포함하여 결과를 제시
- 데이터 및 관련 분석을 포함하여 결과를 제시해야 한다.
- 결과는 명확하고 간결하게 제시되어야 하며, 적절한 경우 표, 그림 또는 기타 데이터 시각화로 뒷받침되어야 한다.
■ 토론 (Discussion): 중요한 결과와 그 영향에 대한 설명을 포함하여 결과에 대한 토론
- 이 섹션에서는 중요한 발견과 그 시사점에 대한 설명을 포함하여 결과에 대해 논의해야 한다.
- 토론은 또한 연구의 한계를 다루고 추가 연구를 위한 영역을 제안해야 한다.
■ 결론 (Conclusion): 주요 결과 및 결론의 요약 및 추가 연구를 위한 권장 사항
- 결론은 주요 결과와 결론을 요약하고 추가 연구를 위한 권장 사항을 제공해야 한다.
※ 경우에 따라 토론과 결론을 하나의 파트로 작성하기도 합니다.
■ 참조 (References): 보고서에 인용된 소스 목록으로, 해당 스타일 가이드에 따라 형식이 지정됨
- 보고서에 인용된 출처 목록으로, 해당 스타일 가이드(APA, MLA, 시카고, 하버드 등)에 따라 형식이 지정된다.
- 모든 출처가 본문에 정확하게 인용되고 참조 목록이 완전하고 정확한지 확인하는 것이 중요하다.
※ 기술 보고서는 의도된 청중에게 적합한 기술 언어를 사용하여 명확하고 간결하게 작성
※ 표제, 글머리 표 및 도표(해당되는 경우)를 사용하여 읽고 이해하기 쉬운 방식으로 형식을 지정
※ 추가적으로, 문법과 철자 오류에 대한 교정을 받아야 한다
기술 보고서 잘 쓰는 법을 질문했는데, 논문 쓰는 방법에 더 가까워 보이긴 합니다. 그래도 이 정도 급으로 보고서를 작성한다고 하면 매우 훌륭한 보고서가 아닐까 싶네요.
ChatGPT를 활용해서 콘텐츠를 만드는 게 꽤나 매력적입니다. 주제를 잘 잡는 게 무엇보다 중요하겠지만, 질문을 잘 만드는 노하우도 있어야겠네요. 한동안 포스팅을 못하고 있었는데 이젠 글쓰기 걱정이 많이 줄어드네요.
