agent-explainer

Generate docs/AGENT_EXPLAINER.md documenting auto-generated repository file purposes.

Updated May 21, 2026

Search Tags:#automation #documentation #onboarding #platform-engineering #repo #explainer #generated-artifacts

Ready to run

npx skills add https://github.com/furqan90/ai_mediated_platform_engineering --skill agent-explainer

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: agent-explainer
Source: https://github.com/furqan90/ai_mediated_platform_engineering/tree/main/skills/agent-explainer
Command: npx skills add https://github.com/furqan90/ai_mediated_platform_engineering --skill agent-explainer

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about agent-explainer

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

FAQPage Schema

How do I automatically generate documentation for auto-generated project repository files?▼

Automatically generate documentation for auto-generated repository files by creating a standardized AGENT_EXPLAINER.md file explaining each artifact's purpose, eliminating team confusion and reducing onboarding time.

What is the best way to explain scaffolded file roles to new developers during onboarding?▼

Explaining scaffolded file roles to new developers is best handled by generating a contextual documentation file that provides a shared mental model, preventing unintended changes to critical generated components and accelerating onboarding.

Why does my platform engineering workflow create files without explaining their purpose?▼

Platform engineering workflows scaffold repositories without context to speed up project creation, but adding an auto-generated explainer document aligns stakeholder understanding and prevents accidental modifications to generated components.

Can I use auto-generated documentation for a Spring Boot service scaffolded via platform engineering?▼

Auto-generated documentation can be used for a scaffolded Spring Boot service to document the role of build scripts, application configuration, and security setup so new contributors can get up to speed immediately.

How do I prevent developers from accidentally modifying critical generated components in a scaffolded repo?▼

Prevent accidental modifications to critical generated components by adding standardized explainer documentation to the repository, giving developers a clear mental model of each artifact's purpose and reducing maintenance errors.

Does auto-generated documentation satisfy project spec requirements for standardized repo documentation?▼

Auto-generated documentation satisfies v1.1 Project Spec requirements for standardized repo documentation by generating a consistent AGENT_EXPLAINER.md file in every new repository to align stakeholder understanding.