문서 자동화 툴

Question

안녕하세요.항상 개발 프로젝트 마친후에 문서 작성해 놓는게 엄청난 스트레스로 다가옵니다. 코드가 스파게티가 아니라, 꼭 클라이언트에서 요청하는 놈들이 있어서요.더 빡치는건 문서 작성한 다음에 예를 들면 노션같은데 적었다고 치면, 코드와 노션 이원화가 발생하기때문에 수정요청 오면 인건비 반나절은 무료로 날아갑니다. 프로젝트 코드는 약 1만 - 2만줄 사이 (C/C&#43;&#43;, Kotlin, Flutter, Swift, Python) 이렇게 작업합니다.당연히 코드는 폴더명, 파일이름 그리고 함수 이름 모두 semantic 하게 해놓았습니다.로직이 복잡한 함수의 경우는 주석도 달구요.프로젝트 코드를 던지면 (input으로 주면) 문서화를 자동으로 해주는 툴이 있나 궁금합니다.왜냐면.. 인건비 아까우니까요 ㅎㅎ 시간아껴서 놀아야죠

HJOW · Answer

문서화 라는 게, API 문서를 말씀하시는건지 매뉴얼을 말씀하시는건지문서라고만 하면 모호해요.자바의 경우 클래스, 메소드에, 일반주석이 아닌 JavaDoc 주석을 달아놓고JDK 안에 내장된 프로그램 돌리면 html 형식으로 API 문서를 깔끔하게 만들어 줍니다.코틀린도 KDoc 이라는 유사한 도구가 존재합니다.다른 언어는... GPT의 도움을...

allinux · Answer

javadoc 같은 것을 찾는 건가요?

basscraft · Answer

여러가지 방식으로 일을 해 보았지만...대부분이 일단 DB설계 후 코딩들어가서 요구사항이 바뀌면 DB ERD 부터 바꾸고 순차적으로 수정 이런 작업이 무한 반복되긴 합니다.결국 매번 수정하기 바쁘니까 제출 장표 채우기 위해 나중에 테스트까지 다 끝나고 몰아서 몇일만에 문서를 찍어내기 하니까 문서의 퀄리티가 매우 낮은것 같습니다.운영하는 사람이 의지하는 것은 문서가 기본일 텐데 대부분의 문서들은 쓰래기 수준이죠.ERD나 잘 되있고 소스나 현행화 되어 있으면 양반... 이게 우리 SI의 어쩔 수 없는 현실...예전에 프로잭트 전체 기간의 7~80%를 문서에 투자해서 AA는 물론 비즈니스 로직, 변수명까지 문서로 정의하고수많은 검증을 거친 후 문서가 완성 되면 비로서 개발에 들어가는 방식으로 해본 경험이 있습니다.3달짜리 프로잭트였는데... 문서작업 2달 넘게 하고 실제 코딩은 2주 정도, 테스트 한달 가까이...문서 작업에 답답함은 있었지만 결과는 나쁘지 않았습니다.요즘도 이렇게 하는지 모르지만 한 20년전 S그룹 계열사 프로잭트 였습니다.이게 맞다 틀리다를 떠나서 기억에 남네요.

genonfire · Answer

직접 적는 것처럼 상세할 순 없지만 swagger 로 흉내는 낼 수 있죠.

문서 자동화 툴

4개의 답변

Q&A 목록