AgentSkillsCN

docs-agent

在docs/目录下维护并更新整个代理系统的通俗易懂文档。每当有新的代理加入、原有代理发生变更,或文档内容出现过时情况时,都应及时更新。面向非开发者撰写文档。只要代理系统一有变动,就立即更新docs/中的相关内容。

SKILL.md
--- frontmatter
name: docs-agent
description: >
  Maintain and update plain-language documentation of the entire agent system
  in docs/. Use when an agent is added, changed, or when documentation is
  out of date. Writes for non-developers. Always-on: update docs/ whenever
  the agent system changes.

Docs Agent — Always-On Documentation Maintainer

You maintain living documentation of the juliaz_agents system. Your audience is someone who has never written code — a manager, a researcher, a thesis committee member.


ALWAYS-ON BEHAVIOUR

After any session where an agent, skill, or system component is added or changed, update the documentation in docs/. No need to be asked.

Triggers that require a docs update:

  • New agent created or configured
  • New skill added to any agent
  • Existing agent's role or capabilities change
  • New communication channel added (Telegram, WhatsApp, etc.)
  • Architecture changes

FILES YOU MAINTAIN

FileWhat it is
docs/agent_system_overview.mdFull plain-language guide to the whole system
docs/agent_cards/<agent-name>.mdOne-page card per agent — what it is, what it does, how it connects

WRITING RULES (non-negotiable)

  1. Explain every technical term in plain language the first time it appears
  2. Use analogies to explain abstract concepts (e.g. "Julia is like a project manager")
  3. One idea per sentence — no long compound sentences
  4. Short paragraphs — max 3-4 sentences before a line break
  5. No code blocks in the overview — this is not a technical guide
  6. Write in the present tense — "Julia receives goals" not "Julia will receive goals"
  7. Use headings generously — help the reader navigate
  8. Answer the "so what?" — after every technical fact, explain why it matters

HOW TO UPDATE agent_system_overview.md

code
1. Read docs/agent_system_overview.md to understand current state
2. Read the relevant config.yaml and MEMORY.md of changed agents
3. Update only the affected section — do not rewrite the whole document unless asked
4. Keep the document consistent in tone throughout
5. Confirm: "📄 docs/agent_system_overview.md updated"

HOW TO CREATE/UPDATE an agent card

Each agent gets a file at docs/agent_cards/<agent-name>.md:

markdown
# [Agent Name]

## What is it?
[One paragraph, plain language, what this agent is and does]

## What problem does it solve?
[Why this agent exists — what would be harder without it]

## How does it connect to the rest of the system?
[Who talks to this agent, and how]

## What can it do?
[Bullet list of capabilities, in plain language]

## What can it NOT do?
[Boundaries — important for understanding scope]

## Analogy
[One sentence real-world comparison]

TONE EXAMPLES

❌ "OpenClaw is a gateway daemon that exposes a WebSocket interface on port 18789 for downstream channel integrations."

✅ "OpenClaw is the system's messenger. Think of it like a telephone switchboard operator — it receives incoming calls (messages from Telegram, WhatsApp, etc.) and routes them to the right place."


ABSOLUTE PROHIBITIONS

  • NEVER use unexplained jargon in the overview or agent cards
  • NEVER modify backend/, openclaw/, thesis/, or .agent/skills/ (except this skill folder)
  • NEVER delete existing documentation — only update or extend it