글쓰기의 중요성 - 개발자가 왜 글쓰기를 연습해야 할까?

안녕하세요. 여름 더위는 잘 버티고 있으신가요? 벌써 말복입니다 ㄷㄷㄷ

더위도 슬슬 꺾여야 하는데 아직도 덥기만 하네요 ㅜㅠ

 

이번에는 출장 중에 다시 한번 느꼈던 글쓰기의 중요성에 대해서 글을 남기려고 합니다.

 

1. 어쩌다가 글쓰기가 중요하다고 느꼈나?

우리들은 프로젝트의 성공을 위해 달려가고 있고, 하나씩 하나씩 이뤄내고 있습니다.

작업을 마치고 숙소로 돌아오면 하루를 복기하면서 느꼈던 점과 개선이 필요한 점을 간단하게 정리합니다.

 

저는 이 메모들을 보면서 우리가 얼마나 이뤄냈고, 무엇이 필요한지 알 수 있습니다.

동기 부여도 돼서 남은 여정을 위한 에너지도 받는 것 같습니다.

 

그런데 문득 걱정이 들더라고요.

다른 분들이 이 메모를 읽어도 똑같은 것을 느낄까요? 제가 대충 적어둔 메모를 보고?

제가 현장에서 경험했던 모든 것들이 값진 자산인데 저한테만 갇혀 있게 되는 것은 아닐까 걱정이 되었습니다.

 

다행히도 같이 출장을 다녀왔던 PO 분들이 내용을 잘 정리하여 조직 내에 공유해 주셨지만

앞으로도 이런 일은 많을 테고 그때마다 다른 분들께 의지할 수는 없을 테니...

 

글쓰기를 연습해야겠다고 느꼈습니다!

 

2. 지금까지 놓쳤던 것은 없을까?

글쓰기를 연습해야겠다고 느끼고 제일 먼저 시작한 것은 제가 놓쳤던 것은 없는지 검토하는 것이었습니다.

 

제가 업무 중에 작성하는 문서들은 주로 개발 작업 문서, 실험 보고서, 회의록 이 3가지입니다.

 

2.1. 개발 작업 문서

개발 작업 문서는 개발자 간 작업 내용 공유를 위해서 작성하는 문서로

해당 개발이 필요한 이유(요구사항, 버그 픽스 등), 우선순위, 구체적인 작업 내용, 테스트 방식을 기록합니다.

 

개발자들 간 매끄러운 협업을 위해서 그리고 나중에 작업 이력을 확인하기 위해서 개발 작업 문서를 작성하고 있습니다.

 

개발 작업 문서의 내용 중 가장 중요한 것은 "이유" 부분인 것 같습니다.

 

물론 어떻게 설계, 구현을 했는지도 중요하지만 "이유"를 알면 더 좋은 설계와 구현을 찾을 수도 있으며

나중에 리팩토링 할 때에도 의도에 알맞게 수정할 수 있기 때문입니다.

 

처음에는 코드를 작성하는 것보다 문서 작성하는 것이 더 어려워서 애를 많이 먹었지만

뭘 해야 할지 대략적으로 제목만 작성되어 있는 문서를 보면 불안할 정도로 익숙해진 것 같습니다.

 

2.2. 실험 보고서

사실 실험 보고서만큼 정형화되어 있는 글도 없을 것 같습니다. 다음 내용들을 "잘" 채우기만 하면 됩니다!

1. 실험의 목적
2. 실험을 통해 확인할 것들(이론, 가설)
3. 실험 방법
4. 실험 결과
5. 결과에 대한 고찰

여기서 "잘"이 중요한데 몇 개월 후에 "내"가 봐도 내용이 이해가 될 정도로 작성해야 합니다.

 

맥락을 알고 있는 실험자는 실험 보고서가 실험 내용을 충실히 작성하지 않았더라도 얼추 이해할 수 있습니다.

하지만 실험에 참여하지 않은 분들은 보고서의 내용에만 의존하며 실험을 이해해야 합니다.

 

1, 2를 작성하고, 다시 읽어보면서 "왜"라는 질문이 나오지 않을 때까지 내용을 보완합니다.

무슨 문제가 있었고, 무엇을 검증하고 싶은지 매끄럽게 전개되어야 합니다.

1. 실험의 목적을 작성할 때에는

1) 어떤 경위에서 이 실험을 진행하게 되었는지 큰 맥락을 작성한 뒤
2) 그래서 이 실험에서 무엇을 확인할 것인지 조금 구체적으로 작성해주면

시간이 지나도 기억하기 좋고, 실험에 참여하지 않은 분들도 조금 더 쉽게 보고서를 읽을 수 있었습니다.


2. 실험을 통해 확인할 것들을 작성할 때에는

1) 무엇을 어떻게 검증할 것인지 쉽게 알 수 있도록 작성하고
2) 글로 작성하기 어려운 경우에는 그림과 영상 자료를 적극적으로 활용합니다.

독자가 실험 방법, 결과를 보기 전부터 골머리 앓지 않게 주의하세요!

 

3 실험 방법은 다른 누군가에 의해서 실험이 재현되어서 같은 결과가 나올 수 있을만큼 자세히 작성되어야 합니다.

실험 결과에 영향을 끼칠 수 있는 요소라면 모두 기록되어야 합니다.

예를 들어서, A* 알고리즘의 속도를 측정하는 실험을 설계한다면 사용한 heuristic 함수, 실험에 사용할 그래프의 크기, PC의 성능을 기록해야 합니다.
만약 본인이 개발한 특수한 자료 구조를 사용했다면 그것 역시 꼭 기록해줘야 합니다.

 

4 실험 결과는 최대한 중립적이고 정확하게 작성되어야 합니다.

독자가 능동적인 가치 판단을 할 수 있도록 적절한 기준을 마련하고, 정확한 수치를 기록합니다.

만약에 단순 수치만으로 결과 해석이 어려운 경우에는 그림, 영상 자료도 적극적으로 확용합니다.

 

5 결과에 대한 고찰은 실험 결과를 얼마나 신뢰할 수 있는지, 이번 실험 결과가 무엇을 의미하는지, 다음 실험으로 무엇을 할 수 있는지 설명해줘야 합니다.

2.3. 회의록

회의록도 실험 보고서와 많이 비슷합니다. 회의가 진행된 이유와 논의된 안건들, 그리고 결론을 정리해야 합니다.

 

하지만 실험 보고서와 다른 점도 명확합니다.

회의는 실험과 다르게 재현할 필요가 없습니다. 대신에 당시의 맥락과 참여자를 정확히 명시하는 것이 중요합니다.

3. 글쓰기를 어떻게 연습할 수 있을까?

일단 많이 써보는 것이 중요하겠죠? 그리고 업무를 진행하면서 문서들을 작성할 때 조금 더 신경써보려고 합니다.

그리고 피드백 받을 수 있는 기회를 최대한 많이 만들어 볼 거에요!

 

글을 쓰고 나만 보지 말고 다른 분들께도 보여주면서 피드백을 받아보면 제 글쓰기의 부족한 부분을 더 쉽게 찾을 수 있을 것 같습니다.

 

그리고 다른 분들의 문서도 많이 읽어보려고 합니다.

읽어보면서 이해가 잘되는 문서와 잘 되지 않는 문서들이 무엇이 다른지 비교하여 저의 글쓰기 습관을 교정해보려고요!