project-feature-explainer

Name: project-feature-explainer
Author: GrishaAngelovGH

15stars2forks

How to install project-feature-explainer?

grishaangelovgh/gemini-cli-agent-skills/project-feature-explainer

$npx -y skills add GrishaAngelovGH/gemini-cli-agent-skills --skill project-feature-explainer

Installs into the current project.

Summary

Expert guidance for explaining project features. Use this skill when you need to provide a comprehensive explanation of how a specific feature works, including summaries, deep dives, usage examples, and sequence/workflow diagrams. This skill has references directory which contain

Files · 1

View on GitHub

SKILL.md

1	# Project Feature Explainer Skill
2
3	This skill provides a systematic approach to analyzing and explaining a specific feature within a codebase.
4
5	## Workflow
6
7	1. Identify Entry Points: Locate the main functions, classes, or API endpoints that trigger the feature.
8	2. Trace Dependencies: Identify the internal modules, services, or external APIs the feature relies on.
9	3. Analyze Data Flow: Understand how data enters the feature, how it's transformed, and where it's stored or returned.
10	4. Draft Explanation: Structure the explanation using the mandatory sections below.
11	5. Verify: Cross-reference the draft with the `references/checklist.md` to ensure completeness.
12
13	## Mandatory Output Structure
14
15	### 1. Feature Summary
16	A high-level overview (1-2 paragraphs) explaining what the feature does and why it exists.
17
18	### 2. Deep Dive (Technical Details)
19	A detailed breakdown of the internal implementation.
20	- Key Components: List the main files/classes/functions involved.
21	- Logic Flow: Step-by-step description of the execution path.
22	- State Changes: Describe any side effects (e.g., database updates, cache invalidation).
23
24	### 3. Usage & Examples
25	Code snippets or CLI commands showing how to use the feature.
26	- Include common parameters and expected outputs.
27	- Provide a "Happy Path" example.
28
29	## Guidelines
30	- Be Concise: Focus on the "how" and "why" without repeating obvious code logic.
31	- Reference Code: Use specific file paths and symbol names.
32	- Contextualize: Explain how this feature fits into the broader system architecture.

People who liked this also viewed

6 picks

Type

project-feature-explainer

15stars2forks

View on GitHub

How to install project-feature-explainer?

grishaangelovgh/gemini-cli-agent-skills/project-feature-explainer

$npx -y skills add GrishaAngelovGH/gemini-cli-agent-skills --skill project-feature-explainer

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# Project Feature Explainer Skill
2
3	This skill provides a systematic approach to analyzing and explaining a specific feature within a codebase.
4
5	## Workflow
6
7	1. Identify Entry Points: Locate the main functions, classes, or API endpoints that trigger the feature.
8	2. Trace Dependencies: Identify the internal modules, services, or external APIs the feature relies on.
9	3. Analyze Data Flow: Understand how data enters the feature, how it's transformed, and where it's stored or returned.
10	4. Draft Explanation: Structure the explanation using the mandatory sections below.
11	5. Verify: Cross-reference the draft with the `references/checklist.md` to ensure completeness.
12
13	## Mandatory Output Structure
14
15	### 1. Feature Summary
16	A high-level overview (1-2 paragraphs) explaining what the feature does and why it exists.
17
18	### 2. Deep Dive (Technical Details)
19	A detailed breakdown of the internal implementation.
20	- Key Components: List the main files/classes/functions involved.
21	- Logic Flow: Step-by-step description of the execution path.
22	- State Changes: Describe any side effects (e.g., database updates, cache invalidation).
23
24	### 3. Usage & Examples
25	Code snippets or CLI commands showing how to use the feature.
26	- Include common parameters and expected outputs.
27	- Provide a "Happy Path" example.
28
29	## Guidelines
30	- Be Concise: Focus on the "how" and "why" without repeating obvious code logic.
31	- Reference Code: Use specific file paths and symbol names.
32	- Contextualize: Explain how this feature fits into the broader system architecture.

People who liked this also viewed

6 picks

Type