writing-for-agents

Guides writing skills, AGENTS.md, and CLAUDE.md documents that agents consume predictably.

Updated Apr 16, 2025
One-click install
npx skills add https://github.com/damoke012/eks_code --skill writing-for-agents-damoke012
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: writing-for-agents
Source: https://github.com/damoke012/eks_code/tree/main/.claude-env/skills/writing-for-agents
Command: npx skills add https://github.com/damoke012/eks_code --skill writing-for-agents-damoke012

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documents written for agents often fail unpredictably: weak descriptions never trigger, bloated files bury key steps, and vague completion criteria let agents stop early. This Skill provides a reference of writing levers that make agent-facing documents behave consistently across runs. ## Core Features & Use Cases - Context pointer design: Write skill descriptions and AGENTS.md lines that front-load trigger words and list distinct branches so agents reach material reliably. - Information hierarchy: Apply progressive disclosure, co-location, and splitting rules to keep documents legible and prevent sprawl. - Completion criteria and pruning: Sharpen step completion conditions, use leading words, and remove duplication, stale caches, and no-op instructions. - Use Case: When authoring a new skill or editing CLAUDE.md, consult this reference to decide invocation mode (model-invoked vs user-invoked), structure the frontmatter description, and prune the body. ## Quick Start Ask the agent to review your draft skill or AGENTS.md file using the writing-for-agents reference and suggest improvements to its description and structure.

Frequently Asked Questions about writing-for-agents

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

FAQPage Schema
How do I write a good skill description for agent discovery?▼

Front-load the leading trigger word, list one trigger per distinct branch the skill handles, and cut anything the body already states. The description is always loaded, so every word must earn its place as a context pointer.

When should a skill be model-invoked vs user-invoked?▼

Choose model-invoked when the agent or another skill must reach it autonomously, accepting the permanent context load of its description. Choose user-invoked with disable-model-invocation when only a human typing its name should fire it.

What is progressive disclosure in agent documentation?▼

Progressive disclosure moves reference material out of the main file and behind a context pointer so it loads only when needed. Inline what every branch requires and disclose what only some branches reach, keeping the top-level document legible.

Why does my agent stop a task before finishing it?▼

Premature completion happens when a step's completion criterion is vague and later steps are visible, pulling attention toward being done. Sharpen the criterion first; if it stays fuzzy, split the sequence across a real context boundary.

Should agent documents restate information from config files?▼

No. The environment is a source of truth, and restating it creates a cache that can go stale. Document only what the agent cannot find by looking, such as unwritten conventions, rationale, and gotchas.