generate-entity-context

Generate CONTEXT.md documentation files for codebase features using templates and code analysis.

6.3k|984|Updated Sep 3, 2010
One-click install
npx skills add https://github.com/rundeck/rundeck --skill generate-entity-context
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generate-entity-context
Source: https://github.com/rundeck/rundeck/tree/main/.claude/skills/generate-entity-context
Command: npx skills add https://github.com/rundeck/rundeck --skill generate-entity-context

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation of standardized CONTEXT.md files for features, simplifying the process of documenting and providing technical briefings for AI entities.

Core Features & Use Cases

  • Feature Documentation: Guides the generation of CONTEXT.md files within feature modules, enhancing technical documentation for AI entities.
  • Code Analysis: Scans feature directories to identify entry points, services, state management, and test files.
  • Template Generation: Utilizes a structured template to generate CONTEXT.md files, including quick facts, architecture, key files, and dependencies.

Quick Start

Run the command /generate-entity-context <feature-path> to generate a CONTEXT.md file for the specified feature.

Frequently Asked Questions about generate-entity-context

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate feature documentation generation for AI entities?

You can automate feature documentation by scanning code directories to identify entry points and services, then generating structured CONTEXT.md files to provide technical briefings for AI entities.

What is a CONTEXT.md file and when do I need it for code analysis?

A CONTEXT.md file provides standardized technical documentation for codebase features, capturing quick facts, architecture, key files, and dependencies to facilitate AI entity maintenance and code analysis.

How do I generate a CONTEXT.md file for a specific codebase feature?

Run the generate-entity-context command with the target feature path. It analyzes the directory structure and uses a template to output the CONTEXT.md documentation file.

Do I need Python to generate feature documentation with code analysis?

Yes, Python is required as the execution environment for running the code analysis scripts and generating the standardized feature documentation files.

What's the best way to standardize technical briefings for AI maintenance across features?

Using template-based documentation generation ensures consistent technical briefings by automatically extracting architecture, key files, and dependencies into a standardized CONTEXT.md format for each feature.

What codebase elements are identified during feature documentation generation?

Feature documentation generation scans directories to identify entry points, services, state management, and test files, mapping these elements into the generated CONTEXT.md template.