johnkimec/scilla

walkthrough

Explain a codebase in one linear document whose code snippets were printed by a command.

소스 보기

사용 방법

  1. 설치 명령을 복사하고 자신의 에이전트 환경에 설치하기 전에 소스 패키지를 확인하세요.
  2. 필요한 도구, 인증 정보, 지원 환경은 원본 문서에서 확인하세요.
  3. 입력과 원하는 산출물을 설명하고 출처와 결과를 대조하세요.
npx skills add https://github.com/johnkimec/scilla --skill walkthrough

시작 전 확인

  • 설치에는 모델 구독, API 한도, 파일 접근 권한이 포함되지 않습니다.
  • 별점 수와 설치 수는 활동 지표이며 독립적인 품질·보안 검증이 아닙니다.
원본 Skill 문서

원본 저장소의 제목, 예시, 코드, 표, 링크, 이미지를 유지해 표시합니다.

Walkthrough

Explain the code in one pass, from the start of the story to the end. A snippet typed from memory is a miss. Commentary, then a command that prints the file, then the output that command produced.

Pass

  1. Read, then plan. Read the source. Plan one order a reader can follow from beginning to end, starting at the foundation or the entry point and moving outward. If the user named a file or an area, stay inside it.
  1. Learn the tool. Run uvx showboat --help and use what it prints.
  1. Write `walkthrough.md` at the repo root. If that file already exists, ask before replacing it. Create it with uvx showboat init.
  1. Alternate notes and printed code. Commentary goes in with uvx showboat note. Every snippet is a uvx showboat exec of sed, grep, cat, find, or wc that prints the bytes on disk. A hand-copied snippet does not go in the note.
  1. Fix a bad command in the document. If an exec fails or prints the wrong lines, uvx showboat pop that entry and run the corrected command.
  1. Check. Run uvx showboat verify walkthrough.md. In the reply, give the path to the document.

관련 작업

같은 저장소의 Skills

더 많은 Skills

모든 Skills