Bỏ qua tới nội dung
TakoAPI
Quay lại kỹ năng

agent-docs

bởi tylervovan

AI & LLMs
2.2kLượt tải do clawskills.sh công bố
4Sao
0Lượt xem
0 lượt thíchĐăng nhập để thích kỹ năng này
—Chưa có đánh giá
Đánh giá của bạn

Tóm tắt

Create documentation optimized for AI agent consumption.

Mô tả

Kỹ năng này làm gì

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.

Khi nào nên dùng

  • 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

Quy trình ví dụ

ĐẦU VÀO

User asks: Create an AGENTS.md for my Next.js project

AGENT
  1. 1

    Identifies stack, architecture constraints, and critical governance rules

  2. 2

    Places security rules and build commands at the top to exploit primacy bias

  3. 3

    Writes a compressed docs index with file paths and function signatures, not full code

  4. 4

    Structures each H2 section to be self-contained for RAG chunk boundaries

  5. 5

    Validates total inline context stays under 4,000 tokens

ĐẦU RA

AGENTS.md with governance rules, a docs index, and architecture constraints ready for agent context windows

Cài đặt

clawhub install tylervovan/agent-docs

Chạy lệnh CLI, hoặc dán prompt vào Claude Code, Cursor, Codex hay coding agent bạn đang dùng.

Liên kết