agents-md-author

Create, review, or refactor AGENTS.md files with YAML frontmatter and references.

3|Updated Jun 23, 2022

Search Tags:#templates #documentation #markdown #governance #references #agents-md

Ready to run

npx skills add https://github.com/fbosch/dotfiles --skill agents-md-author

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: agents-md-author
Source: https://github.com/fbosch/dotfiles/tree/main/.agents/skills/agents-md-author
Command: npx skills add https://github.com/fbosch/dotfiles --skill agents-md-author

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Create, review, or refactor AGENTS.md files so they stay minimal, stable, and useful. Favor a tiny root file that points to deeper docs when needed.

Core Features & Use Cases

Scan for existing AGENTS.md files and related docs to avoid duplication.
Determine scope with the decision tree below and provide guidance for monorepos or single-repo setups.
Draft or refactor the root AGENTS.md with only the essential content and add references to deeper docs as needed.

Quick Start

Draft a minimal root AGENTS.md with a one-line project description and a References section pointing to deeper guidance.

Frequently Asked Questions about agents-md-author

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

FAQPage Schema

What is an AGENTS.md file and when do I need one for my repository?▼

An AGENTS.md file provides a minimal, stable entrypoint for repository onboarding. You need one when managing multiple docs or a monorepo that requires scalable guidance and a clear reference structure to avoid documentation duplication.

How do I create a minimal AGENTS.md file for monorepo onboarding?▼

To create a minimal AGENTS.md, draft a root file with a one-line project description and a References section pointing to deeper docs. Scan existing documentation first to prevent duplication and keep the root file tiny.

How do I refactor AGENTS.md files to keep documentation lean and stable?▼

Refactor AGENTS.md files by moving detailed guidance into deeper referenced docs, leaving only essential content in the root. This approach ensures the entrypoint remains tiny, stable, and scalable for monorepos or multi-doc repositories.

Does an AGENTS.md file require YAML frontmatter and specific components?▼

Yes, the AGENTS.md file adheres to the Skill Unit contract by requiring YAML frontmatter with name and description. It also supports optional scripts, references, and assets to structure the governance and onboarding documentation.

When should I use references in an AGENTS.md file instead of inline documentation?▼

Use references in AGENTS.md when repositories have multiple docs or need scalable guidance. Pointing to deeper docs keeps the root file tiny and stable, preventing content bloat while maintaining a useful onboarding entrypoint.