본문으로 바로가기
윤창원uiwwsw · 작은 우주

개발과 기술

전달 가능한 개발자 문서 — GitHubPrint를 만든 이유

GitHub 링크를 보내고 나면 설명은 끝난 것 같은데, 사실 읽는 사람의 일은 그때부터 시작됩니다.

저장소를 하나씩 열고, README를 읽고, 무엇을 만들었는지 살펴봐야 합니다. 기록은 충분한데 “그래서 어떤 개발자인가요?”라는 질문에 답하려면 다시 순서를 잡아야 합니다.

그 수고를 조금 줄여보고 싶어서 GitHubPrint를 만들었습니다. 로그인한 GitHub 정보를 바탕으로 확인할 수 있는 프로젝트와 사용 기술, 작업 기록의 흐름을 PDF로 정리해주는 서비스입니다.

https://githubprint.vercel.app/

링크를 건넨 다음의 일

개발자는 의외로 자기소개를 자주 합니다. 이직할 때, 협업자를 찾을 때, 사이드 프로젝트나 프리랜서 경력을 설명할 때도 그렇습니다.

GitHub는 좋은 원본 기록입니다. 다만 원본을 건넸다고 해서 전달까지 끝나는 것은 아니었습니다. 상대가 저장소를 돌아다니며 맥락을 직접 찾아야 한다면, 소개서와 함께 숙제도 보낸 셈입니다.

제가 GitHub에서 궁금했던 것도 단순한 커밋 수보다 만드는 방식에 가까웠습니다.

무엇을 자주 만드는가

사용자에게 가까운 문제를 다루는가

작은 아이디어를 여러 형태로 시도하는가

한 가지 주제를 오래 파고드는가

반복되는 일을 도구와 자동화로 옮기는가

이런 흐름을 읽을 수 있도록 기록의 순서를 잡고, 읽기 쉬운 문서로 묶는 데 초점을 맞췄습니다.

문장이 기록보다 앞서가지 않도록

처음에는 공개 프로필만 읽는 방식도 생각했습니다. 이후 로그인한 GitHub 정보를 바탕으로 문서를 만드는 쪽을 택했습니다. 확인할 수 있는 기록의 범위를 넓히고 싶었기 때문입니다. 이때도 어떤 권한을 요청하고 어떤 저장소 정보를 사용하는지는 분명히 드러나야 합니다. 로그인했다는 사실만으로 모든 정보를 읽어도 되는 것은 아니니까요.

정보가 늘어나면 해석에도 욕심이 생깁니다. 몇 개의 프로젝트를 보고 리더십이나 협업 능력까지 설명하고 싶어질 수 있습니다. 문장은 그럴듯해지지만, 기록과의 거리는 멀어집니다.

그래서 만드는 동안 신경 쓴 것은 말의 온도였습니다. 무엇을 확인했고, 거기서 어디까지 읽어낼 수 있는지. 개발자의 전체 역량을 설명하려 들기보다, 문서에 쓴 문장을 뒷받침할 기록이 있는지를 먼저 보려고 했습니다.

회사 업무나 비공개 경험처럼 GitHub에서 보이지 않는 일도 있습니다. 공개 기록이 적다는 이유로 그 사람의 경험까지 적다고 판단할 수는 없습니다. 해석에는 근거와 함께 볼 수 없었던 범위도 남겨야 합니다.

과장하지 않으면서 밋밋하지도 않은 문서. 말로는 짧은 기준인데, 실제 문장을 만들 때는 생각보다 손이 많이 갑니다.

결과물은 PDF입니다

GitHubPrint에서는 GitHub로 로그인하고 분석을 진행하면 대표 프로젝트와 기술, 작업의 흐름을 정리한 PDF를 만듭니다.

저는 처음부터 전달할 수 있는 문서를 만들고 싶었습니다. 웹에서 보기 좋은 화면도 저장하거나 인쇄하면 다른 문제가 생깁니다. 한두 장으로 차분히 읽히고, 다른 사람에게 보내도 흐트러지지 않는 형태를 목표로 삼았습니다.

링크 하나보다는 조금 더 친절하고, 이력서보다는 조금 덜 딱딱한 자료면 좋겠다고 생각했습니다. 자기소개나 포트폴리오의 보조 자료로 쓸 수도 있고, “내 기록이 이렇게 읽히는구나” 하고 살펴보는 데에도 쓸 수 있을 것입니다.

기능은 가능한 한 이 흐름에 맞췄습니다. 로그인하고, 결과를 만들고, 문서로 가져가는 것. 분석 탭과 통계 그래프를 늘리기 전에 그 과정부터 매끄럽게 만들고 싶었습니다.

아직 다듬는 중인 소개

대표 프로젝트를 고르는 방식, 문장의 자연스러움, PDF의 완성도에는 더 손볼 여지가 있습니다. 조금만 과하면 기록보다 말이 커지고, 너무 덜어내면 굳이 문서로 묶을 이유가 없어집니다.

GitHub에 남은 흔적이 저절로 자기소개가 되지는 않습니다. 하지만 읽는 순서와 설명이 조금 달라지면, 저장소를 열기 전에 어떤 질문을 해야 할지는 보일 수 있습니다.

GitHubPrint가 그런 입구가 되었으면 합니다. 문서 한 장으로 개발자를 다 알 수는 없어도, 그 사람이 만든 것을 조금 더 궁금해하게 만드는 입구요.

https://githubprint.vercel.app/

써보신 뒤 느낀 점을 알려주셔도 좋겠습니다.

Assisted by AI

© uiwwsw · 본인 소유의 글·이미지에 대한 무단 복제·재게시를 허용하지 않습니다. 개인 열람·원문 링크 공유·검색 색인과 제한적인 미리보기는 허용합니다. 법령상 이용 예외, 기존 이용 허락, 코드·제삼자 자료의 기존 라이선스는 유지합니다. 콘텐츠 이용 안내

무단 복제·재게시를 허용하지 않습니다. 콘텐츠 이용 안내

윤창원이 벨로그에 남긴 글을 이 작은 우주에도 모았습니다. 사진은 누르면 원본 크기로 볼 수 있습니다. 원문의 전체 서식 보기 ↗

모든 글 둘러보기 →