agent-explainer
CommunityAuto-generate docs explaining each generated file's purpose.
Software Engineering#automation#documentation#onboarding#platform-engineering#repo#explainer#generated-artifacts
Authorfurqan90
Version1.0.0
Installs0
System Documentation
What problem does it solve?
When the AI-mediated platform scaffolds new project repositories, development teams often lack clear context for why each auto-generated file exists, leading to confusion, accidental modifications, and slower onboarding for new team members.
Core Features & Use Cases
- Standardized Explainer Documentation: Automatically generates the docs/AGENT_EXPLAINER.md file in every new repo to document the purpose of all generated artifacts.
- Team Alignment: Provides a shared mental model for developers, reducing questions about scaffolded file roles and preventing unintended changes to critical generated components.
- Use Case: For a new Spring Boot service scaffolded for the orders-platform project, this skill adds documentation that explains the role of the build script, application configuration, and security setup so new contributors can get up to speed immediately.
Quick Start
Use the agent-explainer skill to generate the AGENT_EXPLAINER.md documentation for the new orders-platform project.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: agent-explainer Download link: https://github.com/furqan90/ai_mediated_platform_engineering/archive/main.zip#agent-explainer Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 536,000+ vetted skills library on demand.