mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
bbb1a08ed3
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
46 lines
3.1 KiB
Plaintext
46 lines
3.1 KiB
Plaintext
---
|
|
title: "Mantenimiento"
|
|
description: "Mantén tu documentación precisa y actualizada con el tiempo."
|
|
keywords: ["maintenance", "content lifecycle", "stale content"]
|
|
---
|
|
|
|
<Tip>
|
|
Esta página explica estrategias para mantener tu documentación precisa y valiosa a lo largo del tiempo, desde verificaciones automatizadas hasta ciclos de vida del contenido.
|
|
</Tip>
|
|
|
|
<div id="automate-what-you-can">
|
|
## Automatiza lo que puedas
|
|
</div>
|
|
|
|
Introduce automatizaciones cuando sea posible, como:
|
|
|
|
* **Detecta contenido obsoleto:** Ejecuta un script para señalar la documentación importante que no se haya actualizado en los últimos tres meses. ¿Sigue siendo precisa?
|
|
* **Automatiza las actualizaciones de la documentación:** Crea un flujo de trabajo para actualizar automáticamente la documentación cuando se fusione código con la [API del agente](/es/guides/automate-agent).
|
|
* **Aplica estándares con linters:** Usa [Vale](http://Vale.sh) o [verificaciones de CI](/es/deploy/ci) para detectar automáticamente problemas de formato, desviaciones de estilo de redacción o metadata faltante en cada solicitud de extracción.
|
|
|
|
<div id="set-up-a-review-process">
|
|
## Configura un proceso de revisión
|
|
</div>
|
|
|
|
La documentación quizá nunca sea perfecta, y está bien. Deberías definir un umbral de aceptación en el que la documentación sea funcional y útil.
|
|
|
|
Equilibra eficiencia y calidad:
|
|
|
|
* **Prioriza la documentación de alto impacto.** No todas las páginas necesitan actualizaciones frecuentes. Asegúrate de revisar periódicamente las más importantes para garantizar su exactitud y relevancia.
|
|
* **Aprovecha tu comunidad.** Si tu documentación es de código abierto, habilita que los usuarios señalen problemas o envíen correcciones mediante solicitudes de extracción (pull requests). Esto genera confianza y mantiene el contenido actualizado.
|
|
|
|
<div id="know-when-to-rewrite">
|
|
## Sepa cuándo reescribir
|
|
</div>
|
|
|
|
Con el tiempo, la documentación tiende a acumular advertencias y soluciones provisionales. Cuando los ajustes incrementales generan más confusión que claridad, una revisión completa puede ser la mejor opción.
|
|
|
|
* **Planifique reinicios periódicos.** Una limpieza a fondo, especialmente si las prácticas recomendadas o el producto han evolucionado significativamente, ahorra tiempo a su equipo y a sus usuarios.
|
|
* **Comience con una auditoría estructurada.** Entrevistar a los equipos de soporte, analizar los comentarios de los usuarios y documentar lo que falta, lo que puede inducir a error o lo redundante antes de reescribir.
|
|
* **Realice reescrituras completas en sprints focalizados.** Una revisión completa no tiene que ocurrir de una sola vez. Priorice las secciones con mayor impacto.
|
|
|
|
<div id="wrong-docs-can-be-worse-than-no-docs">
|
|
## Una documentación incorrecta puede ser peor que no tener ninguna
|
|
</div>
|
|
|
|
La documentación desactualizada o engañosa hace perder tiempo a los usuarios y erosiona la confianza. Si una página es completamente inexacta y no se puede corregir a corto plazo, a menudo es mejor eliminarla por completo. Los usuarios valorarán tener menos información antes que información equivocada. |