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枠、ファイルへのアクセス許可は含まれません。
  • スター数や導入数は活動の指標であり、独立した品質・安全性試験ではありません。
リポジトリの原文

見出し、例、コード、表、リンク、参照画像を含む原文を表示しています。

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