[테스팅 실무] 더 나은 버그 보고를 위한 테스터의 글쓰기 2편

더 나은 버그 보고를 위한 테스터의 글쓰기를 하기에 앞서 먼저 어떻게 쓰는 글이 좋은 글인지부터 개념 정립을 해야 한다. 그 첫 번째 아이템은 ‘문단 나누기’다. 필자가 생각하기에 최근 젊은 세대의 글쓰기에서 가장 안 지켜지는 부분이라 생각한다.

문단이란?

문단이란 건 하나의 글 내에서 생각의 단위를 나타낼 때 사용한다. 연관된 문장들을 붙이고 엮어 하나의 문단을 만든다.

문단을 나눌 때 주의해야 할 내용들에 대해 정리해보았다.


① 문단은 생각의 덩어리이다. 여러 문장을 엮어 하나의 문단으로 만들 때 사용한다. 서로 관련이 없는 생각의 덩어리들을 하나의 문단으로 구성해선 안 되며, 서로 연관이 있는 덩어리들로만 엮어야 한다.
② 문단은 줄 띄어쓰기로 구분한다. 문단과 문단을 가르는 방식은 한 줄 띄어쓰기임을 명심하라. 아래 예1처럼 서로 다른 생각의 덩어리를 하나의 문단으로 붙여 써선 안 되며, 예2처럼 문단인지 뭔지 구별이 안 되게 문장을 바로 아랫줄에 쓰는 일이 없도록 해야 한다.

틀린 문단의 예1)

문단 하나에는 하나의 생각만 엮어야 한다.

더 나은 버그 보고를 위한 테스터의 글쓰기를 하기에 앞서 먼저 어떻게 쓰는 글이 좋은 글인지부터 개념 정립을 해야 한다. 문단이란건 하나의 글 내에서 생각의 단위를 나타낼 때 사용한다. 연관된 문장들을 붙이고 엮어 하나의 문단을 만든다.

틀린 문단의 예2)

문단을 구분할 때는 문장을 붙여 써서는 안된다.

더 나은 버그 보고를 위한 테스터의 글쓰기를 하기에 앞서 먼저 어떻게 쓰는 글이 좋은 글인지부터 개념 정립을 해야 한다.
문단이란건 하나의 글 내에서 생각의 단위를 나타낼 때 사용한다. 연관된 문장들을 붙이고 엮어 하나의 문단을 만든다.

옳은 문단의 예)

문단을 구분할 때는 1줄 띄어쓰기로 적용한다.

더 나은 버그 보고를 위한 테스터의 글쓰기를 하기에 앞서 먼저 어떻게 쓰는 글이 좋은 글인지부터 개념 정립을 해야 한다.

문단이란건 하나의 글 내에서 생각의 단위를 나타낼 때 사용한다. 연관된 문장들을 붙이고 엮어 하나의 문단을 만든다.



③ 다시 강조하지만 문단 하나는 하나의 생각 덩어리이다. 그러므로, 문단에도 주제(소제목, 의미의 묶음)가 존재할 수 있다. 그리고, 하나의 문단에는 하나의 생각/아이디어만 존재해야 한다. 두 개 이상의 생각을 하나의 문단에 묶지 말자.
④ 그런데도 너무 지나치게 문단을 많이 만들지 않도록 주의하자.
⑤ 불필요하게 줄 띄어 쓰지 말자. 문장 하나하나를 줄 띄어쓰기 하는 건 0점짜리 글이다.
⑥ 목록/숫자를 나열할 때는 굳이 문단으로 나누지 않아도 된다.

위 ③, ④, ⑤를 위한 틀린 문단의 예1)

두 개 이상의 생각이 하나의 문단에 엮여 있다.

품질보증(Quality Assurance), 혹은 테스트(Testing)를 업으로 삼으려는 모든 신입사원에게 필자는 이런 말씀을 드리고 싶다. (중략) 그래서 필자는 테스팅 업무하실 분들에게 테스터로서 갖춰야 할, 그리고 꼭 알아야 할 글쓰기에 대해 간략히 소개해 볼까 한다. 테스터로서의 본인이 작성할 버그 보고, 결과 보고 등과 관련된 글쓰기 팁을 좀 설명해 보면 어떨까 싶었다.
아래와 같은 방식으로 글을 풀어가려 한다.
① 글쓰기 기본
② 여러 테스팅 전문서적과 소프트웨어 공학 도서에 나온 버그 보고 규칙 및 주의할 점
③ 업계 선배로서, 꼰대로서 드리고 싶은 말씀

위 ③, ④, ⑤를 위한 틀린 문단의 예2)

불필요하게 줄 띄어쓰기가 되어있다.

품질보증(Quality Assurance), 혹은 테스트(Testing)를 업으로 삼으려는 모든 신입사원에게 필자는 이런 말씀을 드리고 싶다. (중략)

그래서 필자는 테스팅 업무하실 분들에게 테스터로서 갖춰야 할, 그리고 꼭 알아야 할 글쓰기에 대해 간략히 소개해 볼까 한다.

테스터로서의 본인이 작성할 버그 보고, 결과 보고 등과 관련된 글쓰기 팁을 좀 설명해 보면 어떨까 싶었다.

아래와 같은 방식으로 글을 풀어가려 한다.

① 글쓰기 기본

② 여러 테스팅 전문서적과 소프트웨어 공학 도서에 나온 버그 보고 규칙 및 주의할 점

③ 업계 선배로서, 꼰대로서 드리고 싶은 말씀

위 ③, ④, ⑤를 위한 옳은 문단의 예)

하나의 문단은 1줄 띄어쓰기로 구분하고, 번호를 나열할 때는 굳이 줄 띄어쓰기를 하지 않는다.

품질보증(Quality Assurance), 혹은 테스트(Testing)를 업으로 삼으려는 모든 신입사원에게 필자는 이런 말씀을 드리고 싶다. (중략)

그래서 필자는 테스팅 업무하실 분들에게 테스터로서 갖춰야 할, 그리고 꼭 알아야 할 글쓰기에 대해 간략히 소개해 볼까 한다. 테스터로서의 본인이 작성할 버그 보고, 결과 보고 등과 관련된 글쓰기 팁을 좀 설명해 보면 어떨까 싶었다.

아래와 같은 방식으로 글을 풀어가려 한다.

① 글쓰기 기본
② 여러 테스팅 전문서적과 소프트웨어 공학 도서에 나온 버그 보고 규칙 및 주의할 점
③ 업계 선배로서, 꼰대로서 드리고 싶은 말씀



⑥ 계속 강조하지만 문장 하나에 여러 논제/주제를 담지 않도록 한다. 문단 하나에는 한 개의 생각이 담겨 있어야 한다. 단락 구성의 구조상 문장 하나에 여러 논제에 관해 이야기해야 한다면, 그렇게 나열하는 문단을 따로 빼면 된다. 그래서 주제를 나열하는 문단 한 개와 주제별 문단이 글에 있으면 좋은 글이다.
⑦ 각 단락의 구조와 분량이 어느 정도여야 한다거나, 같아야 한다는 공식은 존재하지 않는다. 때로는 100줄이 하나의 문단이 될 수도 있고, 때로는 단 1줄이 문단이 될 수도 있다.
⑧ 가능하면 인터넷 게시글 보다는 전문 작가의 책을 읽어 연습하자. 그래야 문장 구조, 문단 구조에 익숙해진다. 인터넷의 글이나 신문 기사는 전문 작가가 쓴 글이 아니다. 도움이 되지 않는다라. (요새 괜히 기자들 대부분을 ‘기레기’라고 부르는게 아니다. 기사의 문장 구조들도 엉망인 경우가 태반이다.)

위 두 개는 굳이 예제를 나열하기에 너무 글이 길어질 듯 해서 Skip 한다.

이에 대해 배움이 필요하신 분들은 글쓰기 기본 관련 초등학교, 중학교 학생들이 보는 참고서를 참고하시면 어떨까 한다. 아니면 실전에서 직접 부딪히면서 배우는 방법도 좋다.



문단 구분과 관련해서는 사실 중학교 교과 과정 정도에 나오는 워낙 기본적인 내용들이다 보니 좀 친절한 척하고 싶어서 길게 썼는데, 혹시 이런 걸로 발표 자료 만드실 분들을 위해 간략히 요약하면 다음과 같다.

  1. 모든 문단은 생각 한 개의 덩어리이다.
  2. 생각 두 개 이상을 하나의 문단으로 만들지 말라.
  3. 모든 문단은 줄 띄어쓰기로 구분한다. 그러니 줄 띄어쓰기에 신경 써야 한다.
  4. 모든 문장을 모두 줄 띄어쓰기로 구분하지 마라. 그건 문단이 아니다.
  5. 문단 내에서 번호를 붙여 나열할 때는 각기 다른 생각의 덩어리이지만 바로 다음 줄에 붙여 쓴다.
  6. 단락은 길 수도 있고, 단 한 줄 일 수도 있다. 단락에 올바른 규격은 없다.
  7. 테크니컬 라이팅(Technical Writing) 강의를 하는 곳이 있다면 꼭 시간을 내서 강의를 듣자.
  8. 필자가 제시하는 해결 방법은 사실 단 하나다. 책을 사라. 책을 읽어라.

2편 끝. 3편에서 계속.



참고 자료