개발일지_5) 개발문서 작성

개발 문서 작성에 박차를 가하고 있는 요즘.

 

한 달에 걸쳐 작성한 코드는 나에게도 온전히 내것이 아니었다.

분석하고 해체하고 체계화해서 다시 조립하고 있다.

다만 이번엔 코드가 아닌 이미지와 글이다.

 

주석을 읽고 고치고 새로 기입하면서

과거의 자신과 대화 하는 기분이다.

꽤 신선하고 재밌다.

 

타인에게 설명하기 위해 자료를 만들다 보니 단점이 많이 보이더라.

꽤 많은 코드를 고쳐썼다.

가장 많이 수정한 부분은 아무래도 이름들이다.

클래스, 패키지, 변수, 메써드...

내 코드를 처음 보는 사람도 이름만으로도 역할을 파악할 수 있도록

또 각각의 서로다른 클래스도 통일성과 일관성을 유지하려고 노력했다.

 

욕심이 많아 문서의 페이지수가 너무 커지는게 아닐까 조금 고민.

꼭 자랑하고 싶은 부분을 솎아 선택-집중하고

챕터 사이에 적절한 스토리 라인을 덧붙여 구성하고 있다.

 

자료는 상세하지만 발표는 간결하게.

 

 

단 한 번의 발표로 청중에게 프로젝트의 개괄 구조를 이해시킬 수 있을까?

 

 

 

 

 

프로젝트) 아파트 실거래가 조회 프로그램

개발문서 내려받기 링크

https://drive.google.com/file/d/1pOSI8Xb5zUA6jzx7iodghVfmSxiyyyrE/view?usp=sharing