개발자는 Document를 작성못해도 상관없다.?

 개발자는 코딩을 잘해야 하고 그것을 하는것에도 시간이없다.

 물론 맞는 말이다.  개발자는 개발에 관련된 지식을 먼저 쌓고 프로그래밍에 대한 노하우를 키워가는것이우선이다. 프로그래밍이라는 것이 단순히 코딩만 잘하면 되는 것은 아니다. 세부적으로 들어가면 많은 프로그래밍 분야는 아키텍쳐, 설계, 품질관리,튜닝 등 많은 분야를 다루고 있고 업무 도메인으로 보아도 쉴수 없이 많은 것이 사실이다.

개발자는 프로그램만 잘해야한다고 생각하는 개발자나 IT 관련 종사자가 있다면 과연 프로그램의 범위를 묻고 싶다. 당신이 말하는 프로그램이라는 범위는 어디까지를 말하는 것인가?

 

우리의 현실…

프로젝트를 진행하다 보면 산출물 또는 보고서를 받아보고 만든다. 하지만 그것에 대한 품질은 아주 낮다고 할수 있다 하지만 우리는 IT문서니까.. 개발자 출신의 PM이 만들었으니까.. 프로그램 짜는데 시간이 없겠지.. 하고 이해를 하려고 한다. 개발업체에서도 그런현실을직시하고 있다.  개발자 또는 개발자였다가 관리직으로 넘어온 많은IT종사자들이 문서작성을 두려워하고 그들이 만들어낸 문서는 볼품이 없다. 하지만 그들은 그들만의 위안을 삼는다. 난 개발자 니까.. 프로그램만잘하면 돼..

 

문서작성을 잘하려면 많은 훈련이 필요한것이 사실이지만 기본적으로 사고가 체계화 되어 있어야한다. 그렇지 않은고는 보고서가 제대로 나오지 않는다. 프로그램을 작성할때 우리나라의 많은 프로그래머 아니 코더가 큰 그림을 보지 못하고 자기의 일만 급급하게 하는 현실에 오는 페해라고 할수 있다.

 

Document를 잘하려면…

언젠가 비  IT 인력과 회의를 자리를참석한적이 있다. 여기서 만난 PM은 예전에도 내가 알고 있는 사람인데 그날따라 IT전문용어를 써가면서 그것도 약어를사용하면서 쉬운 이야기도 어렵게 풀어서 말하는 것이 였다. 회의가 끝난후에 그 PM과 이야기를 나누면서 “왜 그렇게 어렵게 말을 했어요?” 하고질문을 던지자 그PM 왈.. “상대편 사람이 너무 권위적이여서 그렇게 밖에 할수 없었다” 라는 대답이 였다. 물론 회의는 PM이 의도했던 대로끝났다. 문서작성도 그런것 같다. 상대편이 의도했던 대로.. 또는 문서작성자가 의도했던데로 작성하는 것이 중요하다.

문서작성을 위한 스킬은 많은 문서와 많은 보고서가 존재하고 행정업무를 하는 사람이라면 저마다 자기의노하우를 가지고 있다.

그렇기 때문에 문서를 형식에 갖추어서 작성하는 것도 중요하지만 행정업무를 하는 보고서 처럼 형식에치우치는 것보다 IT특성에 맞는 보고서가 필요할것이다.

IT보고서를 잘쓰는 법을 몇가지 적어보면…

1.       1.  전체적인 구조가 명확해야 한다.

전체적인 구조라면 우리가 쓰고자 하는 보고서의 서론.. 본론..결론 순으로 진행해야 한다.

보고서는 전체적인 스토리를 가지고 작성해야 한다는 것이다.

2.       2.문장은 문어체로 작성해야 한다.

문서작성이 처음에 가까운 사람일수록 이런 실수를 많이 저지른다.구어체를 사용하는 것이다. 예를 들면.. ~~ 했음. ~~하고자함. 등과 같은 것도 했습니다. 하고자 합니다. 등으로 적는 다는 것이다. 명사로 종료될것도 동사를 끝으로 하여 구어체로 가깝게 만드는 경향은보고서의 품질을 낮추는 가장 대표적인 예이다.

3.       3.전체적은 문서형식은 절제되도록 작성한다.

보고서는 누구에게 보여주기 위한 수단이다. 그렇기 때문에 보고서는회사를 대표하거나 자신을 대표하며 그에 따른 신뢰성을 주는것은 기본이다. 문서형식을 절제있게 형식을 갖추어서 작성하여야 한다.

4.      4.전문용어는 주석을 달아주는 센스..

IT 보고서의 경우 IT전문용어를 사용하게 되는 경우가많다. 그럴경우는 각주(주석)을 달아주는것이 좋다. 이것도 몰라? 하고 생각할수도 있지만 대다수의 사람들이 모른다고 보면된다. 예를 들면 HTML이것을모르는 사람이 없을 것라고 생각되고 그냥 작성하겠지만 이것또한 주석을 달아주는것이 아주 옳은 판단이다.

5.       5.의도가 명학하고 선택이 분명해야한다.

보고서를 보다보면 주저리, 주저리 말이 많아 어떤것이 원하는 것인지 모를 경우가 종종있다. 그럴때면 강조를 한다던지.. 아니면 불필요한것을 삭제한다던지 해서 의도가 명확하게 드러날수 있도록 작성해야 한다. 또한 선택을 요청할때는 분명하게 예제를 들어준다더지 아니면 향후 어떻게 해야한다던지 분명히 해야한다.

 

 

보고서 또한 하나의 프로그램을 작성하는 단계임을 명확히 말하고 싶다.예전에 내가 아는 프로그래머는 자신은 공부할시간도 모자라서 보고서를 못쓰겠다고 하는것을 본적이 있다. 물론 그 사람은 뛰어난 프로그래머 아니 코더였다.하지만 한단계 업그레이드를 하기 위해서는 보고서 작성 또한 능력을 키워야 한다는 것을 명심해야 한다. 지금 그사람도 팀장이 되어서 보고서를 작성하고있다.