기술이나 제품의 조사 보고서는 결론부터 간단히! 조사 보고서는 대상 기술이나 제품이 시스템에 이용 가능한지 아닌지의 여부를 보고하는 것이다. 읽는 쪽 혹은 고객도 그것을 바란다. 조사 보고서를 작성할 때는 보고자(쓰는 사람)가 쉽게 해버리는 실수가 조사의 이유, 조사의 경위나 조사에 있어서 자신이 실행한 것 등 조사와 관련된 사항을 처음부터 순서대로 자세히 기술하는 것이다.
보고하는 쪽에 있어서는 조사를 제대로한 것을 표현하고 싶거나 전체 내용을 제대로 제공하면 안 된다고 생각해, 조사 내용을 시간의 흐름에 따라 모든걸 기록해버리고 만다. 그러나 고객의, 특히 상급관리자나 경영자가 필요한 것은 조사의 요점이다. 조사 보고서에서 중요한 것만을 간략히 기술하지 않으면 안 된다.
1. 형식에 따라 쓰면 좋다.
조사 보고서는 간략하지 않으면 안 된다. 조사보고서는 조사의 목적, 조사의 방법, 조사 결과, 결론(혹은 고찰) 의 네 항목으로 기술할 필요가 있다. 아래의 구성 예처럼 하나 하나의 항목으로 구성하여 읽기 쉽도록 작성한다.
새로운 기술을 채용한 이미지 인식 소프트웨어 제품 OO이 이번에 개발하는 시스템에 이용 가능한지에 대한 여부를 조사하여, 그 경과와 결론을 아래와 같이 보고합니다.
1. 목적
조사의 목적 (어떤 것을 결론을 위해 조사를 실시하는가)를 간략히 기술
2. 조사
방법조사의 정책, 조사 수단, 조사를 실시했던 환경 등을 간략히 기술
3. 조사 결과
조사의 결과를 간략히 기술
4. 결론
조사의 목적에 대응하는 결론을 기술
2. 목적은 조사 자체가 아니다.
당연한 이야기이지만, 조사의 목적은 조사를 실시하는 것 자체가 아니다. 조사의 결과를 바탕으로 조사 대상 기술이나 제품에 대해 정확한 판단을 하는 것이 목적이다.
새로운 기술을 채용한 이미지 인식 소프트웨어 제품 oo의 동작, 기능을 포함한 성능을 이번에 개발하는 시스템에서 시뮬레이션하여 조사합니다.
위 문장에서는 동작이나 기능, 성능을 조사하는 것을 목적으로 하여 작성하고 있다. 앞서 말했지만, 조사의 목적은 제품이 개발 시스템에 이용가능한지 여부를 확인하고 판단하는 것이다. 엔지니어 자신은 이러한 목적을 인식하고 그 목적에 맞게 조사를 실시해야한다.
위와 같은 보고서는 읽는 쪽의 입장에서는 보고자가 단순히 제품을 실행해 본 것으로밖에 인식되지 않는다. '확인, 판단'을 위한 조사를 실시한 것을 아래의 문장과 같이 명시해두어야 오해의 소지가 없어진다.
새로운 기술을 채용한 이미지 인식 소프트웨어 제품 oo의 동작, 기능을 포함한 성능을 이번에 개발하는 시스템에서 시뮬레이션하여 검증하고, 개발 시스템에 이용가능한지에 대해 확인, 판단합니다.
3. 기술적인 상세 사항은 기록할 필요가 없다.
작업순서, 조작 순서, 동작 환경과 같은 사항은 엔지니어의 특수 영역이다. 그러므로 동작 환경에 대해서 상세한 기술정보를 기록하거나 조작 순서를 구체적으로 상세히 작성하면 기술용어나 전문 용어가 많이 표현될 수 밖에 없다. 이러한 보고서를 받은 상급 관리자나 경영자는 첫 눈에 내던져 버리고 만다. 고객이 알고 싶은 것은 실제로 도입할 시스템을 대상 소프트 웨어를 이용했을 때 제대로 기능될지에 관련된 것이다. 따라서 조사 방법은 실제로 시스템을 이용한 업무와 관련지어 간략히 기술한다. 이때, 조사에 사용한 하드웨어 환경, 소프트웨어 환경, 네트워크 환경, 사용한 데이터의 상세 사항, 조사 항목 등의 조사를 포함한 작업 순서나 조작 순서 등은 따로 참고 자료로써 첨부하자. 그리고 전문 용어는 사용하지 않도록 하자. 고객의 상급 관리자나 경영자가 읽기 쉬운 용어를 사용하자. 예를 들면 아래와 같다.
실제의 업무에서 해당 소프트웨어를 사용하는 환경을 가상으로 유사하게 구축하여, 그러한 업무 시스템 환경에 서 업무와 동일한 작업 절차를 따라 조사를 실시했습니다.
조사 환경, 조사항목을 포함한 작업 순서의 상세한 사항은 별도의 참고자료로 첨부하였습니다.
4. 조사결과를 간략히 기술하자.
'조사결과'의 항목은 자세히 쓰지말고 조사를 의뢰한 사람의 의문점에 대답하는 형식으로 간략히 기술하자.
아래에 조사항목을 포함한 결과를 기술합니다.
● 조사구분1
- 조사항목 A <조사결과의 기술>
- 조사항목 B <조사결과의 기술>
- ...
● 조사구분2
- 조사항목 M <조사결과의 기술>
- 조사항목 N <조사결과의 기술>
- ...
(아래에 모든 조사 구분의 조사 항목에 있어서 하나 하나 조사 결과를 기술)
위의 예는 각각의 조사항목에 상세한 결과를 나열하고있다. 그러나 고객, 특히 상급 관리자나 경영자가 알고 싶은 것은 종합적인 조사 결과이다. 바꿔말하자면 고객의 기대대로인지 아닌지에 대해 알고 싶은 것이다. 하나 하나의 조사 항목의 결과나 각각의 상세한 결과는 흥미가 없다. 그러므로 모든 조사결과를 종합적으로 기술하는 것이 좋다. 하나 하나의 조사항목이나 결과나 상세한 결과 내용은 참고자료로써 따로 첨부하자.
위에 기재한 조사에 의한 검증 결과, 아래와 같이 확인되었습니다.
- 대상 소프트웨어는 개발 시스템에서 문제 없이 동작합니다.
- 업무에 문제없이 사용 가능합니다.
- 업무로 사용시 기대되는 기능, 성능을 발휘합니다.
또한, 상세한 조사 결과는 별도의 첨부 자료로 첨부했습니다.
5. 결론을 명확하게 단정적으로.
조사보고서는 의견을 말하거나 제안을 하기 위한 문서가 아니다. '결론'의 항목은 조사의 결과를 토대로 도출한 결론을 명확히 기술할 필요가 있다.
이번에 검증한 범위에 있어서 만족할만한 결과를 얻었다고 생각합니다. 그러나 어디까지나 가상환경에서의 검증이므로 실제로 업무가 수행되는 환경과 다른 점을 유의해주십시오. 이러한 유보할만한 조건이 있습니다만, 이것은 개발에 큰 영향을 줄 정도라고는 생각하지 않습니다. 대상 소프트웨어 제품은 이번에 개발하는 시스테에 이용하면 문제없을 것으로 생각합니다.
위의 예에서는 결론은 명확하고 단정적이지 않다. 또한 읽는 입장에서 볼 때, 문장 중간에 자신이 없어 보이는 표현이 있어 결론으로 무엇을 말하고 싶은지 명확히 느껴지지 않는다.
보고서는 쓰는 사람(=보고자)가 주체적인 의지를 가지고 결론을 명확하고 단정적으로 표현해야한다. '이용가능하다'인지 '이용불가능하다'인지 판단만을 명확히 기술하는 것이 좋다.
위의 검증결과로부터 종합적으로 판단하여, 조사대상의 소프트웨어는 개발하는 시스템에 이용가능합니다. 대상 소프트웨어의 높은 성능, 다양한 기능을 활용하는 것이 가능하여, 시스템에 큰 메리트를 줍니다.
또한 조사보고서는 1페이지 혹은 2페이지 이내에 맞게 작성하자. 조사 방법이나 조사 결과의 기술이 길어져도 2페이지로 끝맺음을 하자. 그러나 2페이지로 전달할 경우 '결론'을 '조사목적'의 항목 바로 뒤에 배치하도록 하자. 고객의 상급 관리자나 경영자는 한 눈에 결론부터 알고 싶어한다는 것을 잊지 말자. 조사보고서나 조사 결과를 본 후, 페이지를 넘겨 결론이 등장하게 하는 것은 번거롭게 느껴진다.
참고자료
https://www.atmarkit.co.jp/ait/articles/1107/06/news109_3.html
'IT > 일본 IT 회사 생활' 카테고리의 다른 글
[IT 회사 생활] 일본 IT 업계, 사내에서 자주 쓰이는 용어 (0) | 2020.05.24 |
---|---|
[비즈니스 일본어] 틀리기 쉬운 경어 50선 (0) | 2020.05.23 |
[IT 회사생활] 개발자의 올바른 질문법 (0) | 2020.05.12 |
[IT 회사 생활] 테스트 사양서 (0) | 2020.04.22 |
[IT 회사 생활] 테스트의 종류 (0) | 2020.04.22 |