skills.rest
ayubun
ayubunCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

writing-agents-md-files

Generate AGENTS.md files with templates and mandatory freshness dates.

8|1|Updated Feb 25, 2022
Search Tags:#project documentation#AGENTS.md#codebase organization#programming guidelines#architectural documentation
One-click install
npx skills add https://github.com/ayubun/dotfiles --skill writing-agents-md-files
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: writing-agents-md-files
Source: https://github.com/ayubun/dotfiles/tree/main/configs/opencode/skills/ed3d-extending-opencode/writing-agents-md-files
Command: npx skills add https://github.com/ayubun/dotfiles --skill writing-agents-md-files

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill addresses the challenge of creating and maintaining AGENTS.md files, ensuring they are clear, up-to-date, and easily accessible for project documentation.

Core Features & Use Cases

  • Top-Level AGENTS.md: Document project-wide tech stack, commands, conventions, and boundaries.
  • Subdirectory AGENTS.md: Explain domain-level intent, contracts, dependencies, and key decisions.
  • Freshness Dates: Enforce regular updates to AGENTS.md files to maintain accuracy.
  • File Hierarchy: Organize AGENTS.md files at the project and domain levels.

Quick Start

Use the writing-agents-md-files skill to generate a top-level AGENTS.md file for your project.

Frequently Asked Questions about writing-agents-md-files

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

FAQPage Schema
How do I create an AGENTS.md file for my project?▼

To create an AGENTS.md file, use this skill to generate templates that document your project-wide tech stack, commands, conventions, and boundaries. It streamlines the process by providing structured guidelines for architectural documentation.

What is the best way to document architectural intent and contracts in a codebase?▼

Documenting architectural intent and contracts is best handled by creating subdirectory AGENTS.md files. This skill provides templates to explain domain-level dependencies, key decisions, and project-wide conventions for codebase organization.

How do I ensure project documentation stays up-to-date with codebase changes?▼

To ensure project documentation stays up-to-date, this skill enforces mandatory freshness dates within AGENTS.md files. This mechanism enforces regular updates to maintain accuracy and clarity across your codebase organization.

Can I use AGENTS.md files to organize documentation at both project and domain levels?▼

Yes, you can organize AGENTS.md files at both the project and domain levels. This skill supports a file hierarchy that separates top-level project-wide guidelines from subdirectory-specific domain-level intent and contracts.

What should I include in top-level programming guidelines for a new software project?▼

Top-level programming guidelines should include the project-wide tech stack, commands, conventions, and boundaries. This skill provides templates to quickly generate a top-level AGENTS.md file capturing these essential architectural elements.

Related Skills

Explore More Software Engineering Skills→
deepeshBodhdeepeshBodh
35

analysis-codebase

Analyze codebases to extract tech stack, patterns, and collision risks.

Community
Advanced
batuhanysvbatuhanysv

docs-writer

Update repository markdown documentation and generate changelog entries from Git history.

Community
Intermediate
INNERJOINTINNERJOINT

deepinit

...

Community
Advanced
vivshawvivshaw
2

writing-claude-md-files

Create and maintain CLAUDE.md files with Markdown and YAML.

Community
Intermediate