심볼 트랜스클루전
줄 번호가 아닌 이름으로 실시간 코드를 문서에 임베드하세요. 소스를 수정하면 문서도 자동으로 업데이트됩니다.
# 함수를 이름으로 임베드
![[auth.py#validate_token]]Ohai는 auth.py에서 validate_token 함수를 추출하여 구문 강조와 함께 인라인으로 렌더링합니다. 함수가 변경되면 문서도 자동으로 업데이트됩니다.
중요한 이유
전통적인 문서는 낡습니다. 코드를 마크다운에 복사-붙여넣기하면 코드는 진화하고 갑자기 문서가 거짓말을 하게 됩니다. 심볼 트랜스클루전은 소스 파일을 단일 진실 공급원으로 취급하여 이 문제를 해결합니다.
리팩토링할 때마다 깨지는 줄 번호 참조와 달리, 심볼 트랜스클루전은 AST 파싱을 사용하여 실제 이름(함수, 클래스, 구조체, 상수)으로 코드를 찾습니다. 파일 이름을 바꾸고, 코드를 재구성하고, 새 메서드를 추가해도 심볼 이름만 존재하면 문서는 정확하게 유지됩니다.
활용 사례
API 문서
동기화에서 벗어나는 수작업 근사값이 아닌 실제 함수 시그니처를 참조하세요.
아키텍처 결정 기록
ADR에서 논의하는 코드를 임베드하세요. 코드베이스가 진화하면서 예제도 최신 상태로 유지됩니다.
온보딩 가이드
신입 개발자에게 저장소와 일치한다고 신뢰할 수 있는 실시간 코드로 인증 작동 방식을 보여주세요.
코드 리뷰
비동기 리뷰 및 토론을 위해 특정 함수를 마크다운 요약으로 가져오세요.
튜토리얼
실제 구현을 단계별로 안내하세요. 독자는 코드 예제가 항상 최신이라고 신뢰할 수 있습니다.
런북
운영팀이 사고 대응 시 참조해야 하는 정확한 설정이나 스크립트를 임베드하세요.
지원 언어
Tree-sitter AST 파싱을 통한 30개 이상의 언어 지원. JSON 키, YAML 경로, TOML 테이블까지 포함됩니다.
절대 낡지 않는 문서를 경험해보시겠습니까?
Mac용 다운로드