Plantilla de README para tu herramienta
El archivo se abre con cualquier editor de texto (Bloc de notas, TextEdit) o se puede pegar en tus notas.
Plantilla de README para tu herramienta
El README es el manual de tu herramienta, guardado en su carpeta. Te sirve a ti dentro de seis meses, y a cualquier persona (o cualquier IA) que retome la herramienta (lección 8). Una página como máximo.
# [Nombre de la herramienta]
## Para qué sirve
[Una o dos frases.]
## Los archivos
- [archivo]: [para qué sirve]
- [archivo]: [para qué sirve]
## Abrirla
[Cómo, en qué dispositivo, con qué navegador.]
## Dónde están los datos
[Dónde se guardan, qué puede borrarlos.]
## Hacer una copia de seguridad y restaurarla
[Los botones, dónde guardar el archivo, cómo volver a cargarlo.]
## Modificarla sin riesgo
1. Una versión Git antes («antes: …»).
2. La modificación, y luego todas las pruebas de la especificación.
3. Una versión Git después, o una vuelta atrás.
## Último mantenimiento
[Fecha]: [lo que se comprobó]
La solicitud para tu agente
Escribe README.md para esta carpeta, en 25 líneas como máximo, para una persona que no programa, con exactamente estas partes: [pega las partes de la plantilla].
Solo lo que es verdad en los archivos de la carpeta. No crees ningún otro archivo.
La prueba del README
En una sesión nueva, que solo lee el README:
Lee solo README.md. En 3 líneas: dónde se guardan los datos, cómo hago una copia de seguridad y qué pasa si abro la herramienta en otro navegador.
Si la respuesta es falsa o incompleta, lo que hay que corregir es el README.