본문으로 건너뛰기
cccskills
무료GitHub에 공개

ase-code-explain

Explains code with WHAT, WHY, ANALOGY, DIAGRAM, CRUXES, and GOTCHAS. Use when you want to know how code works or when the user asks "how does this work?"

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

설치 방법 보기

포함된 파일(2)

  • SKILL.md4.4 KB
  • help.md1.3 KB

SKILL.md(원문)

설치하기 전에 에이전트에게 전달되는 지시 내용을 확인할 수 있습니다.

@${CLAUDE_SKILL_DIR}/../../meta/ase-control.md @${CLAUDE_SKILL_DIR}/../../meta/ase-skill.md @${CLAUDE_SKILL_DIR}/../../meta/ase-getopt.md

<purpose name="ase-code-explain"> Explain Source Code </purpose> <expand name="getopt" arg1="ase-code-explain"> $ARGUMENTS </expand> <objective> *Analyze* the source code of <getopt-arguments/>, and its directly related source code, and *explain* it in a *brief*, *standardized*, and *concise* way. </objective> <flow>
  1. <step id="STEP 1: Investigate Code Base"> Investigate the code. If the code base is large, you *MUST* use the `Agent` tool (not inline work) to create multiple sub-agents to split the investigation task into appropriate chunks. </step>
  2. <step id="STEP 2: WHAT and WHY"> **Explain the WHAT and WHY**.

    First, explain WHAT the code does (functionality). Second, explain WHY the code does it (rationale).

    Keep your explanations brief and concise.

    <if condition="<ase-project-boxing/> is equal `black`">

    The project source artifacts are classified as a black box, so the user wants only the minimal surface explanation. Output only the WHAT block (omit the WHY block) with the following <template/>:

    <template> <ase-tpl-bullet-normal/> **WHAT** (You should know what): - [...] - [...] - [...] </template> </if> <else>

    Output the result with the following <template/>:

    <template> <ase-tpl-bullet-normal/> **WHAT** (You should know what): - [...] - [...] - [...]

    <ase-tpl-bullet-normal/> WHY (You should know why):

    • [...]
    • [...]
    • [...] </template>
    </else> </step>
  3. <step id="STEP 3: ANALOGY and DIAGRAM"> <if condition="<ase-project-boxing/> is equal `black`">

    The project source artifacts are classified as a black box, so deeper elaboration is not wanted. Skip this STEP 3 and the following STEP 4 entirely: do not output any ANALOGY, DIAGRAM, CRUXES, or GOTCHAS, and do not dispatch any diagram rendering.

    </if>

    Give insights with ANALOGY and DIAGRAM.

    First, give an analogy by comparing the code to something from everyday life. How can I understand this by something I already know? Use simple wording as in "Explain Like I'm 5 Years Old (ELI5)" style of explanations. For very complex concepts, use multiple analogies.

    Second, draw a diagram to show the control or data flow, code or data structure, or code or data relationships. What gives the best overall overview of the code? Build a Mermaid specification <mermaid-spec/>, choosing the Mermaid diagram type per intent: classDiagram for class/method structure, sequenceDiagram for actor/message flow, or flowchart TB for boxes-and-lines component layouts. Then dispatch the rendering to the ase-meta-diagram sub-agent by calling the tool Agent(description: "Diagram Rendering", subagent_type: "ase:ase-meta-diagram", prompt: <mermaid-spec/>, run_in_background: false) and reproduce its returned fenced code block verbatim in the response text. Do not hand-draw.

    Keep your explanation brief and concise. Output the result with the following <template/>:

    <template> <ase-tpl-bullet-secondary/> **ANALOGY** (You should imagine): - [...] - [...] - [...]

    <ase-tpl-bullet-secondary/> DIAGRAM (You should grasp): [...] </template> </step>

  4. <step id="STEP 4: CRUXES and GOTCHAS"> **Highlight CRUXES and GOTCHAS**.

    First, tell what the cruxes of the code are. Is there something one should really notice?

    Second, tell what the gotchas of the code are. Is there something one could really stumble over?

    Keep your explanation brief and concise. Output the result with the following <template/>:

    <template> <ase-tpl-bullet-signal/> **CRUXES** (You should notice): - [...] - [...] - [...]

    <ase-tpl-bullet-signal/> GOTCHAS (You should not stumble over):

    • [...]
    • [...]
    • [...] </template>
    </step>
</flow>

리뷰

아직 리뷰가 없습니다. 사용해 본 소감을 남겨 주세요.

댓글

로그인 없이 쓸 수 있습니다. 사용 후기, 질문, 작동하지 않은 환경 등을 편하게 남겨 주세요.

아직 댓글이 없습니다. 첫 댓글을 남겨 보세요.

보내면 바로 공개됩니다. 이메일 주소나 전화번호 같은 개인 정보는 쓰지 마세요. URL은 2개까지입니다.

0 / 1,000자

이 양식은 reCAPTCHA로 보호되며 Google 개인정보처리방침 및 서비스 약관이 적용됩니다.

같은 저장소의 스킬

Review software architecture, including package cohesion and inter-package coupling

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

rse/ase602026년 10월 19일 업데이트

Discover additional, third-party components (libraries/frameworks) for the technology stack to provide needed functionality.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

rse/ase602026년 10월 19일 업데이트

Analyze the source code for problems in either the logic and semantics and its related control flow, performance and efficiency, or security.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

rse/ase602026년 10월 19일 업데이트

Edit Source Code: Use when the user wants to "edit" the code base in one shot from a query or a bare analyzer issue id like "P1", fusing crafting, refactoring, and resolving with optional grilling, verification, looping, and Git worktree isolation.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

rse/ase602026년 10월 19일 업데이트

Give insights into the source code.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

rse/ase602026년 10월 19일 업데이트

Lint source code for potential code quality problems. Use when the user wants to "lint" or "check" source code.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

rse/ase602026년 10월 19일 업데이트

rse의 스킬 모두 보기

이 스킬의 문제 신고