도리안의 2025년 개발기 #14 - 문서화도 소홀함이 없도록

문서화도 소홀함이 없도록

---

오늘의 개발기

SA 앱 2차 버전이 배포되었다. 그런데 추가 문서 작성을 아직 하지 않았다. 문서라고 해봐야 지금은 프로젝트 폴더에 위치한 readme.md 파일이 전부다. 그러나 프로젝트와 관련된 이런 저런 간단한 정보를 그 곳에 작성하고 있다. 이번에는 2차 버전과 관련된 내용을 추가로 작성했다. 이로써 프로젝트와 관련된 전체적인 그리고 버전별 정보는 readme.md 파일을 통해 언제든 볼 수 있게 했다. 앞으로도 내용 추가는 계속할 예정이며, 내용이 길어지면 다른 파일로 나눌 예정이다.

오늘은 그렇게 문서화 작성을 하였다. 관련 자료와 링크를 다시 찾아보는 데 시간이 조금 들었다. 개발하다가 문서 작성하는 게 일부 개발자들에게는 답답해 할 수 있다. 그렇지만 문서화는 반드시 필요한 작업이며 소홀히 하지 않을 것이다.

---

지난 2025년 개발기

• #13 - 문제를 찾고 해결하는 즐거움
• #12 - 안드로이드 데이터베이스 디버깅 방법 학습
• #11 - 모호한 네이밍은 코드 분석을 어렵게 할 수 있다
• #10 - 감기몸살, 배탈로부터 일상복귀 중
• #9 - 할 일이 없을 때는 코드 복기를...
• #8 - 파이어베이스 관련 크래쉬 이슈 분석으로 헤맨 하루
• #7 - 2차 버전은 개발 대신 코드 리뷰로...
• #6 - AI 개발 도구 커서. 참고해 두자.
• #5 - 유닛 테스트에 대한 개인적인 생각
• #4 - 코드 리뷰 요청, 피드백 받고 후속 조치
• #3 - 정리할 거 빨리빨리 정리하자
• #2 - 파이 차트 그려보기
• #1 - 새해 첫 근무를 마치고......

---

Posted through the ECblog app (https://blog.etain.club)