AgentSkillsCN

explain-codebase

通过详尽的用途说明与架构解析，辅以直观的可视化图表，全面阐释代码库的结构与功能。

SKILL.md
--- frontmatter
name: explain-codebase
description: Explains a codebase with a description of purpose and architecture as well as visual diagrams.
disable-model-invocation: true

When explaining code:

  1. •Describe the motivation: Give the purpose of the codebase. Compare and contrast to other similar software
  2. •Describe high-level architecture: Give a high-level overview of the architecture. Include any services that are required to run it and any high-level modules / design patterns that the codebase utilizes
  3. •(OPTIONAL) Draw a diagram: Use ASCII art to show the flow, structure, or relationships
  4. •Walk through the code: Explain step-by-step what happens for an arbitrary use case
  5. •Highlight a gotcha: What's a common mistake or misconception?