agu 16 - 개발자 글쓰기 필요하다

개발자가 하는 일이 프로그램 짜는 일도 많지만 요즘은 갈수록 프레임웍이나 라이브러리들이 쉽게 공유 되는 환경이라서 문서를 잘 읽고 잘 작성 하는 능력이 꽤나 중요합니다.

 

개발 하는쪽으로 생각이 쏠려 있어서 문서를 쓰려고 하면 또 다른 머리를 써야 하기 때문에 이 전환이 빠르지가 않습니다. 마치 리눅스를 쓰다가 윈도우를 쓰는 것과 비슷하다고나 할까요? Java를 쓰다가 Python을 쓰는 것과 비슷하다고 할까요? 하던 일에서 조금 다른 일을 하려고 하면 생각의 관성을 전환하는데 또한 에너지가 드는 것은 맞는 것 같습니다.

 

머리 쓰는데 에너지가 많이 드는 문제가 아직도 우리 인류를 괴롭히고 있는 것입니다.

 

문서를 논리적으로 이쁘게 깔끔하게 쓰려면 머리를 많이 써야 하는데 훈련이 잘 안되어 있으면 고통스럽다는 것입니다.

나도 기획서 같은걸 써보라고 하면 머리가 넘나 아파서 포기하게 됩니다.

 

어디에서 무슨 문제가 터졌는데 내 예상은 이것인 것 같다. 어떻게 해결했으면 좋겠습니다.

이정도만 써줘도 문제가 비교적 빨리 풀리는 경향이 많은데 실제 현장에서 대체로 주어를 많이 생략을 하는 경우가 많습니다.

척하면 척 이거는 경력자들이나 노하우가 많이 쌓인 조직에서나 가능한 고도의 팀플레이고

 

요즘 처럼 이직도 잦고 기술도 계속 바뀌는 시대에서는 공유를 잘 하는 능력이 굉장히 중요한 것으로 보입니다.

 

유지보수 완료 보고서의 경우는 아래 내용들이 들어가면 얼추맞을 것 같습니다.

1. 무엇을 했는지?

2. 왜 했는지?(목적)

3. 무엇이 개선 되었는지?

4. 어떤 이슈가 있었는지?(진행 중 문제점들)

5. 문제점을 해결 되었는지?

6. 남은 문제는 무엇인지?

7. 남은 문제를 해결 하려면 무엇이 필요한지?

 

end.