『Practicing Rails』가 출시되었습니다! 2월 13일 금요일까지 25% 할인 혜택을 누려보세요.
코드를 작성하는 동안 머릿속에는 끊임없이 질문이 떠오릅니다. "이 메서드는 어떻게 호출하지?", "어떤 옵션을 받지?", "숫자 대신 객체를 전달하면 어떻게 될까?" 같은 것들 말입니다.
바로 이런 질문들이 여러분의 생산성을 무너뜨립니다. 답을 즉시 알지 못하면 하던 작업을 잊어버리기 쉽습니다. 몰입 상태에서 강제로 이탈하게 되고, 다시 원래 자리로 돌아오는 데 30분이나 걸리기도 합니다.
그렇다면 속도를 늦추지 않으면서 필요한 답을 찾으려면 어떻게 해야 할까요?
빠른 문서 검색
API 문서를 찾아볼 때 가장 중요한 것은 속도입니다. 빠르게 답을 얻고 자리를 떠나야 합니다. 그렇지 않으면 금세 엉뚱한 곳으로 샙니다. 메서드의 매개변수를 확인하려다가 어느새 한 시간 동안 레딧 게시글을 훑고 있었던 경험이 얼마나 많은지 모릅니다.
빠른 문서 검색을 위해서는 Mac 사용자라면 Dash를, 그 외 환경이라면 Zeal을 사용하세요. 이 도구들을 활용하면 키 두 번만 눌러 필요한 문서를 즉시 불러올 수 있습니다.
물론 약간의 초기 설정이 필요합니다.
두 앱 중 하나를 다운로드한 후 다음 두 가지를 설정하세요:
-
사용하는 라이브러리의 문서셋(docset)을 다운로드합니다.
저는 Ruby, Rails, CSS, HTML, JavaScript 문서를 받아두는데, 보통 이 정도면 충분합니다. Nokogiri처럼 자주 사용하는 복잡한 젬(gem)이 있다면 해당 문서도 함께 받아두세요. 단, 너무 많이 받지는 마세요. 문서가 과도하게 많으면 정작 원하는
concat메서드가 무엇인지 찾느라 오히려 속도가 느려집니다. -
전역 검색 단축키(Global Search Shortcut)를 설정합니다. 맥에서는 보통 Option+Space를 사용합니다.
이 설정 하나로 Dash가 '그냥 또 하나의 문서 사이트'에서 필수 도구로 탈바꿈합니다. 전역 검색 단축키를 설정하고 나면 Option+Space를 누르고, 타이핑을 시작하고, 필요한 문서를 확인한 뒤, 다시 Option+Space를 눌러 창을 닫기까지 의식조차 하지 않은 채 답을 얻을 수 있습니다. API 관련 궁금증을 스스로 인식하기도 전에 해결하는 셈입니다.
상세 정보, 질문, 커뮤니티 코멘트
안타깝게도 API 공식 문서만으로는 알고 싶은 세부 사항을 모두 얻지 못할 때가 있습니다. 기능이 내부적으로 어떻게 동작하는지 파악해야 할 경우도 있고요.
이런 질문에는 어쩔 수 없이 속도를 조금 포기해야 합니다. 하지만 속도 대신 상세함과 커뮤니티의 지혜를 제공하는 문서 사이트가 있습니다.
APIDock
APIDock은 Ruby, Rails, RSpec만 다루지만 그래도 충분히 유용합니다:
-
Rails 메서드가 언제 지원 중단(deprecated)되었는지, 대신 무엇을 사용해야 하는지 알려줍니다. Rails 1.0부터 버전별 변경 사항을 모두 추적하고 있어서 레거시 Rails 코드를 다룰 때 놀랍도록 유용한 자료입니다.
-
많은 API 메서드에 Rails 개발자들이 남긴 코멘트가 달려 있습니다. 코멘트의 품질도 상당히 좋습니다. APIDock을 활용하면 엣지 케이스나 흔한 문제점을 직접 겪기 전에 미리 파악할 수 있습니다.
새로운 문서 활용 워크플로우
그럼 이 모든 것을 어떻게 조합해서 사용할까요?
- API 관련 궁금증이 생기면 단축키로 Dash나 Zeal을 빠르게 호출합니다.
- 더 자세한 내용이 필요하면 웹으로 이동합니다. 특히 오래된 Rails 앱의 API를 찾을 때는 APIDock을 먼저 확인해 보세요.
문서를 즉시 찾아볼 수 있게 되면 Rails 개발 생산성이 완전히 달라집니다. 집중력이 유지될 뿐만 아니라, 의존하고 있는 라이브러리와 프레임워크에 대해 더 많이 배우게 됩니다.
모든 도구에 대해 모든 것을 알 수는 없습니다. 어느 정도는 언제나 문서에 의존할 수밖에 없습니다. 지금 조금의 시간을 투자해 나중에 찾아보는 시간을 아껴보세요. 그 투자는 프로그래밍 경력 전반에 걸쳐 큰 결실로 돌아올 것입니다.