Mantener la documentación de un repositorio

Escribir archivos Markdown que se puedan incluir en commits sin sorpresas.

Situación. Mantiene un repositorio: un README, especificaciones, planes, un AGENTS.md y una carpeta docs/. El texto debe seguir siendo Markdown limpio porque Git, su equipo y sus herramientas lo leen directamente.

Lo que obtiene al terminar. Documentación actualizada, diferencias Git legibles y ninguna conversión que explicar durante la revisión.

1. Abrir el repositorio como espacio de trabajo

Elija Archivo > Abrir… (⌘O) y seleccione la carpeta del repositorio en lugar de un archivo.

Balise la indexa y muestra dos vistas a la izquierda: Archivos y Esquema.

Añada la carpeta a Favoritos desde el menú de ubicaciones de la barra de herramientas. Después podrá reabrirla en dos clics sin volver al panel de macOS.

2. Escribir en el modo adecuado

El selector Visual y Fuente cambia de modo en cualquier momento dentro del mismo documento.

El modo Visual ayuda a estructurar, completar tablas y marcar tareas. El modo Fuente es más rápido para corregir una sintaxis concreta o pegar contenido técnico.

Lo que se guarda sigue siendo Markdown en ambos modos.

3. Mantener los enlaces

El inspector Documento señala enlaces a archivos inexistentes, imágenes ausentes y anclas ausentes. Úselo para mantener la documentación conforme crece.

4. Renombrar sin romper enlaces

Renombre un documento desde la lista de archivos, en lugar del Finder.

Balise muestra primero una vista previa completa: el nuevo nombre, el posible traslado de la carpeta de recursos, los archivos cuyos enlaces se deben actualizar y el número de línea de cada cambio.

Después aplica el cambio de nombre y la actualización de enlaces juntos.

5. Insertar un diagrama cuando una frase no basta

Insertar abre la galería Mermaid y coloca la fuente en el documento en una sola modificación que se puede deshacer.

El diagrama se dibuja localmente sin solicitudes de red. Sigue siendo texto en el archivo, revisable en las diferencias Git.

Consulte Mantener un diagrama junto al código.

6. Revisar las diferencias antes del commit

Abra las diferencias del archivo en sus herramientas Git habituales antes del commit. Compruebe exactamente lo que contendrá.

Balise nunca escribe en Git. Haga el commit con sus herramientas habituales.

Transmitir contexto a un asistente

Elija Copiar contexto en la barra de herramientas y pegue el resultado en Codex, Claude Code o su agente local habitual. El último resumen preparado aparece primero, seguido del nombre del archivo enlazado a su ruta absoluta. No se adjunta la fuente Markdown ni el archivo; se indica si el resumen es anterior a los cambios sin guardar.

Si algo falla