Esta es una breve descripción del proyecto en la que se debe mencionar el cliente y las tecnologías usadas, recordar mantener esta descripción breve y diferenciarla de otros productos que pueda tener este cliente, así como puede ser una API o incluso otra página similar a esta.
- WordPress:
- PHP:
Mencionar la versión objetivo de Wordpress, PHP y demás para la que se desarrolló este proyecto, de forma que cualquiera pueda descargar el core de dicha versión y ejecutar el proyecto en cualquer ambiente de desarrollo. Adicionalmente, puedes mencionar el rango de versiones en el que ha sido probado en caso de que se necesite actualizar el core. Es importante mantener este archivo actualizado, tanto el equipo de Wordpress como cualquier otro que realice cambios a este proyecto, de forma que si se actualiza el core en base a un requerimiento, se vea reflejado aquí.
En caso de que algún plugin necesite configuración especial o API Keys, se debe dejar por escrito en esta sección para eviar malos entendidos.
En base a sucesos acontecidos se requiere que si la página contiene pagos, se deje por escrito en esta sección, además de como verificar visualmente si estos se encuentran activos (independientemente de si están desactivados, siempre se debe hacer una inspección visual para evitar accidentes), deshabilitarlos y/o cambiar de ambiente para evitar cobros automáticos de suscripciones o productos en ambientes que no sean productivos.
Si consideras que debería haber algo más por escrito en este archivo, no dudes en agregarlo, junto a ello y si consideras de que por la naturaleza de Wordpress, todos los proyectos deberían contener esta sección nueva, no dudes en abrir una rama y agregarlo al repositorio de la plantilla o sugerirlo al equipo de Soporte para que lo agreguen, somos un equipo.
A veces es mejor una imágen para visualizar un proyecto, por lo que puedes agregar diferentes tipos de diagramas usando Mermaid. Ejemplo:
graph LR
A[Square Rect] -- Link text --> B((Circle))
A --> C(Round Rect)
B --> D{Rhombus}
C --> D
Basic writing and formatting syntax
Markdown Cheatsheet - Tables
UML Diagrams in README.md
KaTeX (Math)
Latex rendering