파이썬 패키지 갱신 + 설명서 갱신 후기

(11.11) 수정됨.

코드 정돈은 여전히 어렵다

코드를 작성하는 것도 어렵지만, 이 코드를 적절하게 나누는 것은 더 어렵다.

의식의 흐름대로 기능을 추가해가는 것이 가장 편한데, 이런 식으로 코드를 작성하게 되면 나중에 어느 부분을 수정해야 하는지, 그것이 다른 동작에는 영향이 있는지 확인하기가 어렵다.

이번에는 이런 문제들을 개선하기 위해 코드를 나누었는데, 너무 어려웠다;;

어떻게 나누긴 했지만 잘 나누었다는 생각은 들지 않고, 어떻게 나누어놓는데 성공했다는 느낌이다.

코드 작성하기 <<<< 코드 수정하기 <<<<<<<<<< 코드 정돈하기 <<<<<<<<<<<<<< 코드 설명서 쓰기

코드를 새로 쓰는건 쉽다.

머릿 속 기능을 실제로 구현하는 것에는 어려움이 존재하지만, 그것은 기존 코드를 수정하는 작업보다는 쉽다.

그리고 어느 정도 완성된 코드를 정돈하는 것은 어려운 것은 아니지만, 매우 귀찮다.

코드를 하나하나 살펴보며 어떤 변수가 수정되며, 이것이 외부에서 조정이 가능한 것인지 확인해야 하며, 설명을 붙일 경우 어떤 속성의 변수인지까지 찾아서 주석을 달아야 한다.

말 그대로 귀찮다.

코드 설명서 작성은 위의 모든 것을 포함한다.

내가 놓친 기능은 있는지 찾기 위해 코드를 훑어보아야 하고, 내가 놓친 변수는 없는지 코드를 훑어보아야 하며, 이 변수 또는 함수가 어떤 역할을 하는지 다시 한 번 훑어보아야 한다.

이것이 귀찮게 여겨지는 가장 큰 이유는 역시 코드는 완성되어 작업은 마무리되었고, 작성자 자신 역시 아무 문제없이 코드를 사용할 수 있는데도 불구하고 귀찮게 사용 방법을 기록해야 한다는 것이다.

사람의 기억력은 평생 가지 않기 때문에 자기 자신을 위해서라도 기록을 남겨두어야 한다.

코드 작성과 수정에는 기능 구현이라는 현실적인 어려움이 있지만, 코드 정돈과 설명서 작성에는 어려움은 없다. 단지 귀찮을 뿐..

그런데 그 귀찮음이 기능 구현의 어려움보다 더 크게 느껴진다.. ㅠㅠ

개떡같은 패키지 설명서가 존재하는데는 다 이유가 있었다

너무 귀찮다.

코드를 작성하는 과정에서 코드의 구성, 작동 순서, 어떤 식으로 작동하는지에 대해서는 머릿속에 다 들어있다.

그런데 이걸 글로 풀어내라고??? 코드를 수정하는 것보다는 적은 시간이 걸리지만, 귀찮음은 코드 작성의 10배, 100배는 되는 느낌이다.

거기에 코드 함수나 내부 변수 같은 것도 하나하나 찾아야 하며, 외부에서 건드려도 괜찮은 것, 건드리면 안되는 것까지 구분해야 한다.

이것들만 찾으면 끝이 아니다. 코드를 실행하면 어떤 결과가 나오는지, 어떤 식으로 조정이 가능한지까지 예시를 추가해야 한다.

필요한 경우, 스크린샷까지 하나하나 찍어야 한다.

코드 작성 과정에서 이미 확인하고, 체크하고, 조정까지 해보았는데, 이걸 다시 한 번 해야 한다는 귀찮음이 너무너무너무 강하다.

AI 글쓰기 서식은 최고다

최근 ai 생성물이 급증하면서 검색 결과에 ai가 작성한 게시물을 다수 접하게 되어 짜증이 났었다.

ai 생성물의 가장 큰 특징은 글쓰기 서식이다.

대체로 제목 > 가벼운 설명 > 부연 설명 순인데, 사람이 직접 쓴 글이라 할지라도 이런 구성으로 적혀있다면 ai가 쓴 것은 아닌지 의심부터 들 지경이다.

그런데 이전에 작성해둔 설명서는 난해하다는 생각에 새로운 구성을 찾고 찾다가 결국 ai 글쓰기 서식을 참고하여 작성해야 했는데.. 최고다.

완벽하다고 할 순 없지만, 이전보다는 가독성이 매우 크게 증가했다.

글을 쓰는 과정도 보다 순조로웠다. 생각나는 대로 막 쓰고 정리하기 보다, 무엇을 쓸지 정한 다음, 그것에 대한 설명을 작성하게 되니 작성하는 것도 쉽게 느껴졌다.

그래도 귀찮은 건 변하지 않지만...