mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
d7096d55cd
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
53 lines
2.7 KiB
Plaintext
53 lines
2.7 KiB
Plaintext
---
|
|
title: "Personalizar el comportamiento del agente"
|
|
description: "Configura cómo el agente maneja tareas de documentación con AGENTS.md."
|
|
keywords: ["AGENTS.md", "agent configuration", "custom instructions", "agent customization"]
|
|
---
|
|
|
|
Crea un archivo `AGENTS.md` en tu repositorio para personalizar el comportamiento del agente (también se acepta `Agents.md`). El agente lee este archivo y sigue cualquier instrucción que proporciones.
|
|
|
|
El agente busca archivos `AGENTS.md` en dos ubicaciones. Primero revisa el directorio de documentación y luego la raíz del repositorio. Si tienes archivos `AGENTS.md` en ambas ubicaciones, el agente utiliza el archivo que está en tu directorio de documentación.
|
|
|
|
Añade todas las instrucciones que quieras que el agente siga. El agente agrega estas instrucciones a su prompt del sistema, por lo que se aplican a todas las tareas, tanto si usas el agente en tu dashboard, en Slack o mediante la API.
|
|
|
|
<div id="what-to-include-in-agentsmd">
|
|
## Qué incluir en AGENTS.md
|
|
</div>
|
|
|
|
Considera agregar instrucciones sobre:
|
|
|
|
- **Preferencias de estilo**: Voz, tono, formato y terminología específica de tu documentación.
|
|
- **Estándares de código**: Lenguajes de programación, frameworks y convenciones de codificación que se deben usar en los ejemplos.
|
|
- **Requisitos de contenido**: Qué secciones o información se deben incluir para diferentes tipos de páginas.
|
|
- **Contexto del proyecto**: Detalles específicos sobre tu producto, arquitectura o base de usuarios que guíen las decisiones sobre la documentación.
|
|
|
|
<div id="example-agentsmd-file">
|
|
## Ejemplo de archivo AGENTS.md
|
|
</div>
|
|
|
|
```markdown AGENTS.md
|
|
# Documentation agent instructions
|
|
|
|
## Code examples
|
|
- Use TypeScript for all code examples. Our users are primarily TypeScript developers.
|
|
- Always include error handling in API call examples.
|
|
- Show both success and error response examples for all endpoints.
|
|
- Include import statements at the top of code examples.
|
|
|
|
## API documentation standards
|
|
- Every endpoint must document: authentication requirements, rate limits, and common error codes.
|
|
- Use real-world parameter values in examples (not foo/bar placeholders).
|
|
- Include a complete request/response cycle for each endpoint.
|
|
|
|
## Style and formatting
|
|
- Write for developers with 2-5 years of experience. Don't oversimplify, but explain non-obvious concepts.
|
|
- Use active voice and second person ("you").
|
|
- Date format: ISO 8601 (YYYY-MM-DD).
|
|
- When referencing UI elements, use bold: **Settings** button.
|
|
|
|
## What to include
|
|
- Add prerequisite sections to guides when users need API keys, environment setup, or dependencies.
|
|
- Include "Next steps" sections linking to related documentation.
|
|
- Add troubleshooting sections for common issues we see in support tickets.
|
|
```
|