Instrucciones de Claude para documentación
Copia, adapta y reutiliza estas instrucciones para escribir, actualizar, reorganizar, traducir y auditar documentación con Claude conectado a OpenDocs.
La biblioteca de instrucciones
Escribir
- “Redacta una página de primeros pasos para [producto] en el espacio [espacio].”
- “Escribe una página de preguntas frecuentes que responda estas cinco preguntas: [lista].”
- “Convierte estas notas de reunión en un artículo de cómo hacerlo y déjalo sin publicar para revisión.”
- “Escribe una entrada de notas de versión para este cambio: [descripción].”
- “Redacta una lista de verificación de incorporación para nuevos [rol].”
- “Resume esta página larga en una versión corta de referencia rápida y publícala junto a la original.”
Actualizar
- “Busca páginas que mencionen [término anterior] y actualízalas a [término nuevo].”
- “Actualiza la página de Configuración con estos nuevos pasos: [pasos].”
- “Reescribe la introducción de [página] para que sea más clara y corta.”
- “Revisa la página de Precios contra nuestros planes actuales y corrige lo que esté desactualizado.”
Reorganizar
- “Mueve la página de Facturación bajo Configuración de Cuenta y reordena por encima de Seguridad.”
- “Divide la página de Incorporación en tres páginas separadas: Configuración, Ajustes y Puesta en Marcha.”
- “Combina estas dos páginas sobre claves de API en una sola y archiva la duplicada.”
- “Reorganiza la sección de Solución de Problemas por área de producto en vez de por fecha.”
Traducir
- “Traduce la página de Configuración al inglés y al portugués y publica ambas.”
- “Revisa qué páginas del espacio [espacio] no tienen traducción al inglés.”
- “Vuelve a traducir [página] a todos sus idiomas existentes ahora que cambió el original.”
- “Publica esta página en inglés, portugués y alemán, manteniendo la misma estructura.”
Auditar
- “¿Qué buscaron los lectores este mes que no encontró resultados?”
- “Encuentra páginas que no se han actualizado en más de un año.”
- “Lista cada página que todavía mencione [función descontinuada].”
- “Revisa el árbol de páginas del espacio [espacio] en busca de enlaces internos rotos.”
SOPs
- “Entrevístame sobre cómo manejamos [proceso] y redacta un SOP con mis respuestas.”
- “Agrega una sección de excepciones y escalamiento a la página de [nombre del SOP].”
- “Publica este SOP para el equipo de Operaciones, sin publicar hasta que se apruebe.”
- “Compara la página publicada de [nombre del SOP] con lo que acabo de describir y marca lo que haya cambiado.”
Documentación de API
- “Redacta una página de referencia para el endpoint [endpoint] con ejemplos de solicitud y respuesta.”
- “Actualiza la página de autenticación para describir el nuevo formato de clave de API.”
- “Escribe una guía rápida que lleve a un desarrollador nuevo desde el registro hasta su primera llamada a la API.”
- “Encuentra cada página de referencia de API que todavía muestre la URL base anterior y corrígela.”
Preguntas frecuentes
¿Estas instrucciones funcionan en claude.ai, Claude Desktop y Claude Code?
Sí. Una vez que OpenDocs está conectado, las mismas instrucciones funcionan en claude.ai, Claude Desktop y Claude Code. claude.ai y Claude Desktop se conectan vía OAuth en todos los planes; Claude Code se conecta con una clave de API de OpenDocs, que requiere el plan Enterprise o Compliance.
¿Por qué a veces Claude pregunta antes de terminar una instrucción?
Claude pregunta antes de acciones que eliminan o reemplazan contenido, como borrar una página o sobrescribir su texto, para que confirmes antes de perder algo. Cada cambio que sí hace queda guardado en el historial de la página.
¿Puedo combinar varias de estas instrucciones en una sola solicitud?
Sí. Claude puede encadenar pasos en una sola instrucción, por ejemplo buscando páginas desactualizadas y actualizando cada una que encuentre, aunque dividir un cambio grande en varias instrucciones facilita revisarlo sobre la marcha.
¿Necesito saber el nombre exacto del espacio o la página para que funcionen estas instrucciones?
Ayuda, pero no es obligatorio. Claude puede buscar primero en tus espacios y páginas, y pedirte que confirmes cuál querías decir antes de hacer un cambio.