25
25
.. _Memory & project docs : https://github.com/openai/codex?tab=readme-ov-file#memory--project-docs
26
26
.. _contextFileName : https://github.com/google-gemini/gemini-cli/blob/3a369ddec3b226dea9d1a9dcc3bae048310edffd/docs/cli/configuration.md?plain=1#L36
27
27
.. _path\: CLAUDE.md : https://github.com/search?q=path%3ACLAUDE.md&type=code
28
+ .. _Gemini CLI : https://github.com/google-gemini/gemini-cli
29
+ .. _Aider : https://aider.chat/
30
+ .. _Windsurf : https://windsurf.com/
31
+ .. _Copilot : https://github.com/features/copilot
28
32
29
33
==================
30
34
Docs for AI agents
@@ -36,6 +40,17 @@ What are docs for AI agents? How are they different than internal eng docs? Do
36
40
we really have to maintain the agent docs and eng docs as separate docs sets?
37
41
This page contains my notes on these questions.
38
42
43
+ Scope:
44
+
45
+ * I work on *developer * docs i.e. docs for software engineers. I don't know
46
+ how relevant AI agents are for technical writers in other industries or
47
+ domains.
48
+
49
+ * I'm thinking specifically about docs for AI *agents *. I'm not
50
+ sure that an all-encompassing "docs for AI best practices" exists. The way
51
+ that we optimize docs for RAG-based chatbots (for example) is probably
52
+ different than the way we optimize docs for AI agents.
53
+
39
54
-----------------
40
55
Internal eng docs
41
56
-----------------
@@ -63,7 +78,8 @@ AI agents
63
78
64
79
As a software developer, your primary interface for interacting with an AI
65
80
agent is through a chat interface that's been bolted onto your CLI (e.g.
66
- `Claude Code `_) or IDE (e.g. `Cursor `_). The power of AI agents is their
81
+ `Claude Code `_, `Gemini CLI `_, `Aider `_, etc.) or IDE (e.g. `Cursor `_,
82
+ `Windsurf `_, `Copilot `_, etc.). The power of AI agents is their
67
83
ability to combine LLM capabilities with **tools ** like web search and
68
84
``grep ``.
69
85
@@ -199,6 +215,7 @@ References:
199
215
* `Share with your team `_
200
216
* `Memory & project docs `_
201
217
* `Manage Claude's memory `_
218
+ * `Rules `_
202
219
203
220
-------------------------
204
221
Gotta keep 'em separated?
0 commit comments