코드 변경 내역을 장별 안내서로 공유할 수 있다

125개 파일이 바뀐 기능 브랜치도 6개 챕터로 나눈 가이드로 볼 수 있다. 실제 예시를 브라우저에서 열어볼 수 있다: 125개 파일 브랜치의 6개 챕터 가이드. 버그 수정 사례는 5개 챕터로 구성돼 있다: 버그 수정 가이드.

Plannotator의 Guided Review은 코드 변경분을 중요도 순으로 설명하는 가이드다. 이 가이드를 HTML 파일로 내려받거나 링크로 공유할 수 있어, 코드 변경을 검토하는 사람에게 유용하다.

Guided Review은 어떤 가이드인가?

Guided Review은 코드 변경분을 챕터로 나누고, 각 챕터의 짧은 개요와 관련 파일을 변경 내용과 나란히 보여준다. 변경분을 중요도 순으로 설명하는 코드 안내서라고 보면 쉽다. 내보낸 가이드는 HTML 파일 하나로 만들어진다.

가이드는 어떻게 만들고 공유하나?

코딩 에이전트에 plannotator-guide 기술을 사용해 브랜치, PR 또는 커밋의 가이드를 만들도록 요청하면 된다. 이 기술은 챕터를 작성하고 파일을 만든다. Plannotator 사용자는 Guided Review 뒤에 ‘Download portable guide’를 선택해 같은 결과물을 내려받을 수 있다.

npx skills add plannotator/guides

파일을 내려받는 대신 이 사이트에 올려 링크로 공유할 수도 있다. 사이트는 파일이 기기 밖으로 나가기 전에 암호화(내용을 알아볼 수 없게 바꾸는 처리)하며, 복호화에 필요한 키는 URL의 # 뒤에 남는다. 브라우저는 이 부분을 서버에 보내지 않으므로 호스트에는 내용을 읽을 수 없는 데이터만 저장된다는 설명이다. 링크 전체를 가진 사람만 가이드를 열 수 있다. 링크는 요청하지 않는 한 만료되지 않으며, 업로드 때 받은 삭제 토큰으로 가이드 하나를 지울 수 있다.

오래된 링크와 직접 호스팅은 어떻게 되나?

뷰어 빌드는 /v1/ 아래에 저장되며, 한 번 공개된 뒤에는 바뀌지 않는다. 따라서 지난해 만든 가이드도 같은 방식으로 열린다. 파일을 내려받으면 코드에 관한 정보는 이 사이트로 전송되지 않는다. 뷰어는 Cloudflare Worker로 만들었으며, 직접 실행할 수도 있다: 저장소의 apps/guides-show.

사용하려면 코딩 에이전트에 plannotator-guide 기술을 추가하거나 Plannotator에서 Guided Review을 이용하면 된다. 원문은 서비스 가격과 업로드 파일의 크기 제한을 밝히지 않는다.