산출물 검토중에 문제가 예상되는 증상들..


문서가 다음과 같은 증상이 있다면

  1. 문서의 내용이 체계적이지 않다. 두서가 없고, 문장의 구조가 없다. 읽고는 있으나 뭐라고 말하는지 도대체 모르겠다.
  2. 문서에서 쓸데없는 내용이 적혀있다.  이 문서에 넣어야 하는 Scope에 대해서 작성자도 전혀 생각하고 있지 않다.

 

예상되는 결과

  1. 시험 시나리오를 짤 수가 없다.
  2. 구현이 제대로 되었는지 당연히 알 수 없다. 추적관리란 건 당연히 기대할 수 없다.
  3. 내용이 이해가 안되는 것은 당연한 일이므로 죄책감 갖지 말자
  4. 설계가 제대로 된건지 파악할 수가 없다. 내용 파악이 안되는걸 가지고 엔지니어가 아니라서 잘 모르니까 그러는 것이라고 담당자가 드립을 칠 수도 있는데, 그건 사실이 아닌 경우가 많다.
  5. 일의 진척상황을 파악할 수가 없다. 애시당초 scope조차도 모르는데, 일정 시간이 지나고 지겨울 때쯤이면 출시하자고 하겠지.. 그래서 출시하면 곤란한 상황에 처할 수 있다. 그건 이런 상황에서는 자연스러운 일이니 너무 놀랄 필요도 없다.

 

이런 현상의 원인들

  1. 시간이 없으므로 문서작성에 시간을 들일 시간이 없다. – 틀린 말은 아니며, 그간 놀았거나 아니면 계획을 제대로 세운게 아니란 것이다. safety critical 개발철학은 어느정도의 문서화는 필요하다. 안드로이드 앱이나 게임같은거 개발할거 아니면 (이 표현이 앱이나 게임을 비하하는 의미가 전혀 아니고, 문서화를 안해도 가능한 도메인이 있을 수 있다는 의미임)
  2. 솔직히 고백해서 문서화 잘했으면 문과갔을 것이고, 그거 못해서 이과 왔는데, 문서만들라고 해서 짜증나는 것임. 생각해 본적도 없고 훈련받아본적도 없음. 그냥 싫은 것임
Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s