agent-docs
بواسطة tylervovan
AI & LLMsموجز
Create documentation optimized for AI agent consumption.
الوصف
ما الذي تفعله هذه المهارة
Guides writing documentation structured for AI agent consumption, covering token efficiency, RAG chunking, and context hierarchy. Applies to AGENTS.md constitutions, llms.txt indexes, SKILL.md files, and API docs read by LLMs. Based on Vercel benchmarks showing inline docs achieve 100% agent task pass rates versus 53% with retrieval-only approaches.
Inline AGENTS.md achieves a 100% agent task pass rate compared to 53% for tool-based retrieval alone, because agents skip fetching docs they assume they already know from training.
متى تستخدمها
- Writing AGENTS.md constitutions for a new codebase
- Generating a llms.txt index for an existing project
- Structuring API docs so an agent retrieves the right chunk
- Auditing a README for token efficiency before adding it to agent context
- Creating SKILL.md files for OpenClaw agent workflows
مثال على سير العمل
User asks: Create an AGENTS.md for my Next.js project
- 1
Identifies stack, architecture constraints, and critical governance rules
- 2
Places security rules and build commands at the top to exploit primacy bias
- 3
Writes a compressed docs index with file paths and function signatures, not full code
- 4
Structures each H2 section to be self-contained for RAG chunk boundaries
- 5
Validates total inline context stays under 4,000 tokens
AGENTS.md with governance rules, a docs index, and architecture constraints ready for agent context windows
التثبيت
clawhub install tylervovan/agent-docsشغّل أمر واجهة سطر الأوامر، أو الصق النص في Claude Code أو Cursor أو Codex أو أي وكيل برمجة تستخدمه.