기술 보고서의 요약문은 어떻게 써야 하나요?

이 단계는 무언가를 승인하거나, 예산을 배정하거나, 일정을 잡아야 하는 공장장이나 생산 책임자에게 올리는 사내 기술 보고서에 맞습니다. 학술지 초록, 규제 제출 서류, 계약이나 고객이 요약 형식을 정해 둔 보고서는 각자의 규칙을 먼저 따릅니다.

기술 보고서 요약문을 쓰기 전에 무엇이 필요한가요?

기술 보고서 요약문을 쓰려면 먼저 완성된 보고서, 특정한 독자 한 명, 그 독자에게 받으려는 결정이 있어야 합니다. York St John University는 본 보고서를 마친 뒤에 요약문을 쓰라고 권합니다(York St John University, n.d.). Texas A&M University Writing Center는 분명한 한계를 하나 더 둡니다. 보고서가 구체적으로 다루지 않은 내용은 넣지 않는다는 것입니다.

초안을 쓰기 전에 네 가지를 한 장에 모읍니다. 첫째는 요청입니다. 시험 승인, 유체 교체, 플러싱을 위한 라인 정지, 공급사 시정 조치 수용 같은 것입니다. 둘째는 독자의 관심사입니다. Texas A&M 지침에 따르면 요약문을 읽는 사람은 대개 프로젝트의 기술적 세부보다 "비용, 마케팅, 생산성, 효율"에 관심이 있습니다. 셋째는 요청을 뒷받침하는 발견 사항 3~5개이며, 각각 수치, 단위, 근거를 갖춰야 합니다. 넷째는 독자가 발견 사항을 얼마나 믿을 수 있는지를 바꾸는 한계입니다. 시료가 하나뿐이거나 시험이 아직 진행 중인 경우가 그 예입니다. 요청을 한 문장으로 쓸 수 없다면 아직 요약문을 쓸 때가 아닙니다.

기술 보고서 요약문을 쓰는 단계

공장장에게 올리는 기술 보고서 요약문은 네 단계를 순서대로 밟아 씁니다.

1. 요청을 맨 앞에 씁니다. 필요한 결정, 결정 기한, 담당자를 처음 두 문장에 넣습니다.

2. 영향을 밝힙니다. 발견 사항마다 이 공장의 생산, 품질, 안전에 미치는 영향으로 다시 쓰고, 문장이나 글머리표 하나에 발견 사항 하나를 담습니다.

3. 수치로 보여 줍니다. 모든 발견 사항에 단위가 붙은 수치와 근거를 답니다. 무엇을 쟀는지, 어떤 기준과 비교했는지, 어느 날짜나 어느 배치인지를 적습니다.

4. 방법의 세부 내용은 본문에 남깁니다. 시험 절차, 계측기 설정, 원자료, 배경 설명은 보고서에 두고, 그 내용이 있는 절을 가리킵니다.

Carnegie Mellon의 안내 자료는 같은 작업을 독자의 세 가지 질문, 곧 "무엇을 알아야 하는가? 왜 신경 써야 하는가? 무엇을 해야 하는가?"로 정리합니다(Carnegie Mellon University, n.d.). 1단계는 마지막 질문에 먼저 답합니다. 공장장은 행동하려고 읽기 때문입니다. 2단계와 3단계는 공장장이 왜 신경 써야 하는지에 답하고, 공장장이 회의에서 그대로 옮겨 말할 수 있는 근거를 줍니다. 4단계는 공장장의 시간을 아껴 줍니다. Digital.gov의 쉬운 글쓰기 지침도 같은 순서를 뒷받침합니다. 긴 문서는 앞에서 요약하고, 목록을 쓰고, 도움이 되는 곳에는 표를 쓰라는 것입니다(Digital.gov, n.d.).

공장장에게 올리는 기술 보고서 요약문에서는 무엇을 맨 앞에 써야 하나요?

공장장에게 올리는 기술 보고서 요약문에서는 요청을 맨 앞에 쓰고, 그 요청을 정당화하는 발견 사항 하나를 바로 뒤에 씁니다. 공장장은 첫머리를 읽고 계속 읽을지 정하는 경우가 많습니다. 그래서 처음 두 문장에 결정, 기한, 이유를 담습니다.

Carnegie Mellon의 안내 자료는 한 예시 요약문을 "결과를 앞세우지 않는다"고 지적하고 분명한 권고도 없다고 비판합니다. 고쳐 쓴 예시는 선택한 안으로 시작합니다(Carnegie Mellon University, n.d.). 반면 Texas A&M 지침은 명시적인 권고를 끝에 둡니다. 요약문의 대부분을 차지하는 "Close the Deal" 부분에 넣는 방식입니다(Texas A&M University Writing Center, n.d.). 두 지침 모두 독자를 의사결정자로 봅니다. 다른 점은 요청을 어디에 두느냐입니다.

공장장에게는 요청을 앞에 쓰고, 마무리에서 담당자와 날짜를 붙여 다시 씁니다. 첫머리 예시는 다음과 같습니다. "11월 14일까지 3번, 4번 라인에서 대체 절삭유를 2주간 시험하는 안의 승인을 요청합니다. 최근 두 차례 점검에서 3번 라인의 공구 수명이 줄었으며, 이번 시험으로 절삭유가 원인인지 확인할 수 있습니다." 이 예시의 수치는 설명을 위한 값이며 데이터가 아닙니다.

기술 보고서의 발견 사항은 생산, 품질, 안전 영향으로 어떻게 바꿔 쓰나요?

기술 보고서의 발견 사항을 생산, 품질, 안전 영향으로 바꿔 쓰려면 발견 사항마다 현장에서 무엇이 달라지는지 묻습니다. 생산량과 정지 시간인지, 불량과 재작업인지, 사람에 대한 위험인지를 따집니다. Texas A&M 지침에 따르면 경영진 독자는 대개 기술적 세부보다 생산성과 효율에 관심이 있습니다. Carnegie Mellon은 발견 사항을 회사의 수익이나 사명과 연결하라고 권합니다(Carnegie Mellon University, n.d.).

아래 표는 발견 사항을 공장장에게 맞게 다시 쓰는 방법을 보여 줍니다. 발견 사항과 값은 모두 예시입니다.

가장 중요한 행은 첫 번째입니다. 대부분의 공장장에게 "점도가 등급 범위보다 낮음"은 아무 의미가 없습니다. 반면 "계획되지 않은 정지를 피하려면 정기 정지 때 오일 교체"는 조치하지 않았을 때의 비용을 말해 줍니다. 독자가 보고서에서 근거를 찾아볼 수 있도록, 측정값은 영향 문장 옆에 함께 적어 둡니다.

어떤 기술적 세부 내용을 요약문이 아니라 보고서 본문에 남겨야 하나요?

시험 절차, 계측기 설정, 시료 ID, 원자료 표, 계산 과정, 문헌 배경은 요약문이 아니라 기술 보고서 본문에 남깁니다. Carnegie Mellon은 방법을 덜 강조하라고 권합니다. 방법이 보고서의 핵심 주제가 아니라면 경영진 독자는 "결정을 내리는 데 방법이 필요할 가능성이 낮다"는 것입니다(Carnegie Mellon University, n.d.).

독자가 발견 사항을 얼마나 믿을 수 있는지가 달라지는 방법상의 사실은 하나 요약문에 남깁니다. Texas A&M 지침은 방법이 해결책에 이르는 데 중요한 요인이었다면 간단히 설명하고, 한계를 얼버무리지 말라고 합니다(Texas A&M University Writing Center, n.d.). "가동 정지 중 채취한 시료 한 건을 근거로 함"은 요약문에 들어갑니다. 채취 밸브나 시료병 종류는 들어가지 않습니다. Texas A&M 지침이 권하는 대로, 꼭 써야 하는 기술 용어에는 짧은 정의를 붙입니다.

공장 밖으로 보내는 요약문은 한 번 더 걸러야 합니다. 내부 비용 메모나 다른 고객의 데이터처럼 고객이나 제조사가 아예 보면 안 되는 내용이 있기 때문입니다. 이 문제는 요약문보다 범위가 넓으며 고객용 기술 보고서에서 빼야 할 내용에서 다룹니다. 공장 안에서는 기준이 더 단순합니다. 그 세부 내용이 없어도 공장장의 조치가 달라지지 않는다면, 그 내용은 절 번호를 달아 본문에 남깁니다.

기술 보고서 요약문에서 숫자는 어떻게 써야 하나요?

기술 보고서 요약문의 숫자는 구체적이어야 하고, 단위와 근거를 갖춰야 하며, 독자가 이미 쓰는 기준과 비교해야 합니다. Texas A&M 지침은 "일반론보다 가능한 한 많은 구체적 사실"을 요구합니다. "앞으로를 낙관합니다" 대신 증가율을 몇 퍼센트로 밝히는 예를 듭니다(Texas A&M University Writing Center, n.d.). Carnegie Mellon은 독자가 아는 벤치마크와 결과를 비교하고 "얼마나?"를 물어보라고 제안합니다(Carnegie Mellon University, n.d.).

이 규칙은 대부분의 공장 보고서에 적용됩니다. "일부", "다수", "상당한" 같은 말은 개수나 값으로 바꿉니다. 모든 값 옆에 단위를 적습니다. SI 단위로 쓰고, 공장에서 쓰는 단위가 다르면 괄호 안에 함께 적습니다. 근거를 밝힙니다. 비교한 기준이나 기준선, 시료, 날짜를 적습니다. 결정에 필요한 정밀도로 반올림하고, 전체 값은 본문에 둡니다. 모든 곳에서 같은 숫자를 씁니다. 예를 들어 요약문에는 18%, 본문 표에는 17.6%로 적혀 있으면 어느 쪽이 맞느냐는 질문이 나옵니다.

예시를 하나 들면 "11월 3일 시료의 40 °C 점도는 182 mm2/s로, 해당 등급 범위 198~242 mm2/s보다 낮았습니다"라는 문장은 차이의 크기, 기준, 날짜를 한 문장으로 공장장에게 알려 줍니다. 이 문장의 값은 예시입니다.

지침마다 기술 보고서 요약문의 분량이 다른 이유는 무엇인가요?

지침마다 기술 보고서 요약문의 분량이 다른 이유는 쪽수 상한을 정하는 지침도 있고 보고서 대비 비율을 정하는 지침도 있기 때문입니다. 두 방식은 중간 길이의 보고서에서만 일치합니다. Carnegie Mellon은 요약문이 "보통 한 쪽이지만 전체 보고서 분량의 최대 10%까지 될 수 있다"고 합니다(Carnegie Mellon University, n.d.). Texas A&M University Writing Center는 줄 간격 두 줄 기준으로 한두 쪽, 또는 전체 보고서의 약 5%라고 합니다(Texas A&M University Writing Center, n.d.). MIT의 한 강의 작성 지침은 "대체로 한 쪽을 넘지 않지만, 긴 제안서나 보고서에는 더 긴 요약문이 필요할 수 있다"고 하고(MIT OpenCourseWare, 2003), York St John은 한 쪽을 권합니다(York St John University, n.d.).

비율은 보고서 분량에 따라 커집니다. 예를 들어 60쪽짜리 연구 보고서라면 10%는 6쪽으로, 어떤 쪽수 상한보다도 깁니다. 쪽수 상한은 보고서 분량과 관계없이 유지됩니다. 짧은 보고서를 다루는 강의 지침이 쪽수 상한을 쓰는 이유입니다.

공장장에게는 쪽수 상한을 적용합니다. 한 쪽, 이메일이라면 한 화면이 공장장이 회의 전에 읽는 분량입니다. 요약문이 그 안에 들어가지 않는다면 보고서에 결정이 둘 이상 담겨 있을 가능성이 큽니다. 결정마다 요약문을 따로 쓰는 것이 맞습니다.

기술 보고서 요약문은 보내기 전에 어떻게 점검하나요?

기술 보고서 요약문을 보내기 전에는 다섯 가지 합격·불합격 기준으로 점검한 뒤, 보고서 없이 전달받았다고 생각하고 한 번 읽어 봅니다. 아래 표로 요약문을 보내도 되는지 판단할 수 있습니다.

가장 중요한 행은 마지막 행입니다. 임원이나 공급사에 전달된 요약문은 보고서 없이도 이해돼야 합니다. Texas A&M 지침은 전체 보고서의 문장을 복사해 붙여 넣지 말라고도 하므로, 본문에서 그대로 가져온 문장이 없는지 요약문을 다시 읽어 봅니다. 루빈플라의 문서 작성은 태스크를 제안할 때 독자를 정하고, 승인 카드에서 그 독자를 확인합니다.