내 프로젝트 전체를 AI에게 검토시키는 법: project-to-md

개발할 때 함수, 파일 하나를 AI에게 검토시키면서 답답할때가 있습니다.

전체 맥락을 알아야 해결할 수 있는 이슈인 경우 현재의 GPT나 Claude 에서 제공하는
Chat 인터페이스에선 해결하기가 쉽지 않지요.

이런 문제를 해결하기 위해 한가지 툴을 만들었습니다.

이 툴은 프로젝트 파일 전체를 합쳐 마크다운으로 변환시킵니다.
변환된 마크다운 문서를 GPT나 Claude 혹은 RAG를 지원하는 기타 코드 및 도구에 추가하고 원하시는 대로 프로젝트 전체를 검토하시면 됩니다. 단일 파일 검토에서는 생각지도 못한 이슈를 해결해주기도 합니다.

저는 이 방법으로 상당한 개발 속도 향상을 경험했습니다.

1. 현재보다 더 나은 파일구조 만들기
- 알아서 표준에 가까운 파일명, 파일구조를 제시해줍니다.

2. 관련된 2~3개 이상의 파일을 언급하여 수정요청
- 함수간의 관계를 파악하여 적절하게 수정해줍니다.

3. Github 업로드를 위한 Readme 내용 만들기
- 현재 레퍼지토리의 내용도 이 방식으로 초안을 뽑았습니다

4. 최근 핫하지만 아직 AI 모델에 학습 되지 않은 패키지를 받아 검토시키기.
- 해당 패키지에 대해 질문했을 때 이상한 결과물을 뽑을 확률이 크게 줄어듭니다.

위는 제가 사용했던 예시이고, 사용자의 배경에 따라 활용법은 더 많을것으로 생각됩니다. 다른 괜찮은 사용 예시가 있다면 공유해주세요. 그럼 편안한 개발 되시길 🤖

https://github.com/EasyDevv/project-to-markdown

GitHub - EasyDevv/project-to-markdown: Project To Markdown: Project files into structured markdown, optimizing documentation for AI analysis. Enhances AI assistants' performance in understanding project context, featuring both GUI and CLI interfaces. Ideal for improving AI-powered code comprehension and problem-solving.

GitHub

GitHub - EasyDevv/project-to-markdown: Project To Markdown: Project files into structured markdown, optimizing documentation for AI analysis. Enhances AI assistants' performance in understanding project context, featuring both GUI and CLI interfaces. Ideal for improving AI-powered code comprehension and problem-solving.

다음 내용이 궁금하다면?

또는

이미 회원이신가요?

2024년 9월 3일 오전 5:45

댓글 0