런타임 코드 맵을 사용하여 새 코드에 온보딩

그래서 저는 최근에 다음에서 영감을 받았습니다.

Aleksey Kladov (matklad) 에 대한 Architecture.md ,

의 잘 알려진 블로그 게시물

AppMap 사용자와의 대화

아시다시피 요즘 취업 시장은 개발자들에게 좋습니다! 많은 회사가 고용 모드에 있습니다. 예를 들어 Shopify는 doubling their team이며 2021년에는 2021명이 고용됩니다.

새로운 일을 시작하는 것은 설레기도 하지만 스트레스도 많이 받습니다. 고용하는 경우 신입 사원이 새로운 위치에서 편안함을 느낄 수 있도록 돕는 것이 중요합니다. 준비하기 위해 할 수 있는 일이 많이 있지만 여기서는 한 가지 측면에만 초점을 맞출 것입니다. 바로 코드 기반에 익숙해지는 것입니다.

신입사원 오리엔테이션을 위한 Wiki가 있기를 바랍니다. 이 Wiki는 신입사원들이 직접 만들고 유지 관리합니다. 신입 사원이 새 계정을 모두 확보하고 물건을 찾을 위치를 알고 팀과 점심을 먹었으면 티켓을 받고 문제를 수정하거나 개선할 때입니다. 그리고 그것이 Architecture.md가 오는 곳입니다. Aleksey의 말을 인용하자면:

Roughly, it takes 2x more time to write a patch if you are unfamiliar with the project, but it takes 10x more time to figure out where you should change the code.

응. 가장 큰 문제는 관련 코드가 어디에 있는지 아는 것입니다!

이제 Aleksey의 게시물에서 그는 코드에 대한 자세한 링크를 권장하지 않습니다. 코드가 변경되고 링크가 부실해질 것이기 때문입니다. 그래서 그것에 대해 생각했고 자세한 코드 링크를 포함하고 최신 상태로 유지하는 방법을 제안합니다.

다음은 간단한 제안입니다. 대화형 코드 맵에 대한 링크로 Architecture.md를 개선하고 개발자에게 이러한 코드 맵을 생성하기 위해 실행할 수 있는 명령을 제공합니다. 위의 비디오에서는 데모용으로 Rails 샘플 앱을 사용하고 있습니다. rake 작업은 Architecture.md에서 사용하는 모든 코드 맵을 생성합니다.

bundle exec rake appmap:architecture

개발자가 이 명령을 실행하면 Architecture.md에서 사용하는 모든 AppMap이 코드와 함께 최신 상태로 유지됩니다. 따라서 Architecture.md의 텍스트 콘텐츠에 대한 보충 자료로 사용할 수 있습니다. Markdown에서 코드 맵으로, 직접 소스 코드로, 그 반대로 이동할 수 있습니다. 코드 맵에는 HTTP 서버 요청, 종속성 라이브러리 및 자세한 SQL이 포함되어 있으므로 신입 사원이 방향을 잡는 데 사용할 수 있는 풍부한 정보와 세부 정보가 있습니다.

동영상을 통해 연습을 확인하세요. 다음은 비디오에 제공된 일부 리소스에 대한 링크입니다.

Rails Sample App - appmap-e2e branch

AppMap Discord

AppMap quick start guides

훌륭한 Architecture.md를 만들기 위한 다른 팁과 트릭이 있습니까? 댓글로 알려주세요!