Técnicas para documentar tus proyectos web

COMPARTE

[ad_1]

Una de las mejores cosas de crear sitios web es que eventualmente enfrentarás el mismo desafío más de una vez. Esto significa que sabrá exactamente qué hacer la próxima vez. Eso es si recuerdas dónde y cuándo has visto el problema antes.

¿Cuántas veces ha necesitado lograr algo y se dio cuenta de que había escrito un código que encajaba perfectamente? Entonces, ¿cuántas veces ese mismo fragmento ha sido casi imposible de encontrar?

Este es un desafío común para los diseñadores web. Esta es la razón por la que escribir la documentación básica del proyecto puede ser beneficioso. Al implementar un sistema de este tipo, tendrá una manera fácil de encontrar ese fragmento que le ahorrará tiempo.

Ya sea que esté trabajando en un nuevo proyecto o revisando proyectos anteriores, aquí hay algunos consejos para documentar lo que ha hecho.

Comenta tu código

Este parece un poco obvio, pero no obstante es importante. Cuando escribimos código, tiene sentido agregar comentarios apropiados sobre lo que hace exactamente.

La práctica común es escribir una breve historia sobre cada característica nueva para explicar su propósito y relevancia. Más allá de eso, agregar notas en otros lugares clave en estas funciones nos ayuda (y a otros que revisan nuestro código) a comprender mejor cómo encaja todo.

Y esta práctica no está reservada para lenguajes complejos como PHP o JavaScript. También es perfecto para CSS. Enumerar estilos específicos y dónde se usan es excelente para encontrar exactamente lo que necesita.

A menudo parece que la mitad de la batalla es simplemente recordar por qué cada línea está ahí y qué se supone que debe hacer. Los comentarios pueden eliminar gran parte de esta ambigüedad.

Agregar comentarios a partes clave del código sirve como referencia útil.

Crear un registro para cada proyecto

Dependiendo de tu personalidad, la mención de la palabra «diario» puede ser increíblemente aterrador o extrañamente reconfortante. De cualquier manera, hay un gran valor en la práctica.

En este caso, estamos hablando de un documento que sirve como recurso de un proyecto futuro. Si el sitio web deja de funcionar o necesita una nueva función, este sería un lugar al que puede consultar para obtener más detalles sobre cómo se configuraron las cosas.

Abra un documento de procesamiento de texto o continúe y cree un Wiki en su instalación local. Puede ser tan detallado (o no) como quieras. No hay reglas estrictas y rápidas aquí.

Por ejemplo, nuestras técnicas de diseño y desarrollo tienden a evolucionar. El enfoque que tomó hace unos años puede no parecerse a lo que hace hoy. Por lo tanto, es importante poner varios elementos del proceso por escrito.

Además, incluso cuando se utilizan sistemas y bibliotecas comunes, cada sitio web es una entidad separada. ¿No sabes por dónde empezar? Mire lo que hace que el sitio sea diferente de los demás.

Tenga en cuenta las plantillas especiales que haya creado, los fragmentos de código específicos o los estilos. Si está configurando una configuración de un solo servidor, eso también es una gran cosa para documentar.

Llevar un diario del proyecto te ayudará a recordar los pequeños detalles.

Mantener una biblioteca de fragmentos de código

No hay necesidad de reinventar la rueda cuando se trata de código. Gran parte de lo que escribimos es infinitamente reutilizable. Incluso si no coincide por completo con las necesidades de su nuevo proyecto, el fragmento correcto puede servir como un sólido punto de partida para una mayor personalización.

Sin embargo, organizar fragmentos dispares de código puede ser un desafío. Simplemente puede copiar y pegar elementos útiles en un documento y recuperarlos según sea necesario. Pero para aquellos que escriben un gráfico de código, podría salirse de control con bastante rapidez.

Un repositorio de GitHub podría ser una solución razonable. Esto le permitiría clasificar las cosas y establecer el control de versiones. Incluso puede sincronizar un repositorio con otro servicio para poder usarlo o acceder a él de diferentes maneras.

Independientemente de cómo armes una biblioteca de fragmentos, querrás desarrollar algún tipo de sistema para etiquetar, categorizar o etiquetar cada fragmento. Por ejemplo, puede agregar cosas como el lenguaje de codificación utilizado, el objetivo, la aplicación relevante (como WordPress) o la biblioteca (React, Vue, Bootstrap). Esto hará que sea mucho más fácil encontrar lo que necesita.

Un depósito de fragmentos de código le permite encontrar fácilmente elementos de uso común.

Una enciclopedia de tu trabajo.

A los diseñadores web les encanta crear portafolios para mostrar su trabajo. Pero monitorear proyectos internamente también es una tarea encomiable. Puede ayudarlo a solucionar problemas y desarrollar sitios web existentes mientras brinda soluciones para los nuevos.

Puede usar cualquiera o todas las técnicas anteriores para organizar las cosas. La mejor parte es que puedes personalizar las cosas como mejor te parezca. Ya sea que se trate de tomar notas voraces o de simples recordatorios, lo ayudará a comprender mejor el qué, dónde, cuándo y por qué de sus proyectos web.

[ad_2]