WP_Post Object
(
    [ID] => 23813
    [post_author] => 1
    [post_date] => 2018-01-31 11:14:33
    [post_date_gmt] => 2018-01-31 10:14:33
    [post_content] => 

Un desarrollo web bien documentado en fases puede ahorrar un tiempo valioso que se traduce en rentabilidad para la empresa

El contraste de las diferentes fuentes de información

Hace unas cuantas décadas, cuando las personas querían ahondar en un tema específico u obtener información sobre él, su primera y más fiable opción de la que echaban mano eran los libros. Estos recursos eran —y siguen siendo— una fuente de información estática: su contenido no varía ni cambia de lugar. Es por ello que presentan la grandísima ventaja de que, si uno anota la página y el párrafo donde encontrar cierta información de interés, en todas las copias de dicho libro y de la misma edición podrá encontrar exactamente esa información.

Con la llegada de Internet, los libros pasaron a un segundo plano para dar paso a una nueva tecnología que permitía buscar información al momento sobre cualquier tema, sin moverse de la silla, con solo unas pocas pulsaciones de teclado y unos cuantos clics de ratón. Sin embargo Internet tiene una desventaja: es una fuente de información efímera y dinámica. Lo que hoy se puede encontrar en una página concreta, mañana puede no ser accesible.

He solido ver a gente buscar hasta cuatro y cinco veces la misma información, por el simple hecho de que consideraban que el abrir una nueva pestaña y buscar cuatro palabras clave era más eficiente que tomarse el tiempo de anotar la información que encontraron cuando realizaron la búsqueda la primera vez.

La percepción general sobre la acción de documentar

Cuando digo “documentar” me refiero tanto a la acción de recoger información y guardarla de forma inalterable en algún lugar, como a desarrollar una documentación sobre una tarea, proceso, código de programación o cualquier otro asunto que pueda requerir de ello.

Es innegable que generar documentación es “lo aburrido”, lo que nadie quiere hacer. Básicamente, porque se tiene la percepción de que el documentar algo está separado o alejado de la tarea que se está realizando.

Archivadores

Las ventajas de documentar los cambios web

Comparto las que, a mi parecer, son las principales ventajas de documentar el trabajo de desarrollo web:

  1. La primera de todas es que se puede contextualizar la información que se ha encontrado: una mínima descripción sobre el problema y en qué contexto se aplica la solución o información encontrada puede ayudar en un futuro a volver a utilizar dicha información o descartarla simplemente echando un vistazo a la información de contexto.

  2. Ahorramos tiempo al poder discernir en un momento si se puede parar de buscar en ese momento o hay que obviar dicha solución e una nueva búsqueda. Además, la “meta información” que se recoge en forma de contexto permite ampliar el alcance de los términos de búsqueda que se utilicen en el sistema de información.

  3. Otra de las ventajas de contextualizar la información es que se podrán recoger todos los detalles a tener en cuenta para poder utilizarla o aplicarla de nuevo. En ocasiones, una solución encontrada depende de realizar una serie de pasos previos, o de preparar un entorno específico. Si no se hace así, después de un tiempo será muy probable que dichos detalles se olviden.

  4. En el caso de los procesos o la realización de tareas, documentar nos ayuda a reproducir exactamente los pasos que se han de dar para llegar a una solución efectiva. De nuevo, quiero hacer hincapié en que de esta forma no se olvidarán los detalles que pueden hacer que un proceso falle.

  5. Si existe la posibilidad de compartir esta información, los agentes que se enfrenten a estos procesos por primera vez puedan seguirlos de forma exhaustiva, para la satisfactoria consecución de la tarea que se le ha asignado.

  6. Evitar el problema del constante cambio de Internet. Al guardar una copia de la información, no importa que dicho recurso online desaparezca, ya que se dispondrá de una copia —ya sea local o en la nube— a la que poder referirse siempre, dentro del sistema de información. Aquí se genera la reflexión de las ventajas y desventajas de tener un sistema de información en la nube o en local, pero es una reflexión que creo atañe realizar a cada persona, y valorar dónde decide guardar su información y porqué.

  7. Comprender más profundamente aquello sobre lo que se documenta. El proceso de generar documentación requiere una síntesis del problema y la solución para documentar el contexto, que puede incluso llegar a ayudar a la persona a darse cuenta de que la información recogida es insuficiente o quizás no es aplicable en dicho contexto.

Conclusión

Por lo tanto, en mi opinión, documentar no sólo nos ayuda en el aspecto de ahorro de tiempo en un futuro, sino también en profundizar en el problema y ayudar a comprenderlo mejor. Además, como ya he comentado, puede incluso ayudarnos a centrarnos en otras cosas mientras remitimos dichos documentos a personas que nos han pedido ayuda. De esta forma, si más adelante tenemos dudas, podremos partir de una base en la que la otra persona ya está dentro de un contexto, sin tener que explicarle todo el proyecto desde el principio.


Mikel Alejo Barcina Ribera

Web Software Engineer en GuGo Creative

Créditos

[post_title] => Ventajas de documentar los cambios web [post_excerpt] => [post_status] => publish [comment_status] => closed [ping_status] => closed [post_password] => [post_name] => ventajas-documentar-los-cambios-web [to_ping] => [pinged] => [post_modified] => 2018-01-31 11:15:21 [post_modified_gmt] => 2018-01-31 10:15:21 [post_content_filtered] => [post_parent] => 0 [guid] => http://gugocreative.com/?p=23813/ [menu_order] => 0 [post_type] => post [post_mime_type] => [comment_count] => 0 [filter] => raw )

Un desarrollo web bien documentado en fases puede ahorrar un tiempo valioso que se traduce en rentabilidad para la empresa

El contraste de las diferentes fuentes de información

Hace unas cuantas décadas, cuando las personas querían ahondar en un tema específico u obtener información sobre él, su primera y más fiable opción de la que echaban mano eran los libros. Estos recursos eran —y siguen siendo— una fuente de información estática: su contenido no varía ni cambia de lugar. Es por ello que presentan la grandísima ventaja de que, si uno anota la página y el párrafo donde encontrar cierta información de interés, en todas las copias de dicho libro y de la misma edición podrá encontrar exactamente esa información.

Con la llegada de Internet, los libros pasaron a un segundo plano para dar paso a una nueva tecnología que permitía buscar información al momento sobre cualquier tema, sin moverse de la silla, con solo unas pocas pulsaciones de teclado y unos cuantos clics de ratón. Sin embargo Internet tiene una desventaja: es una fuente de información efímera y dinámica. Lo que hoy se puede encontrar en una página concreta, mañana puede no ser accesible.

He solido ver a gente buscar hasta cuatro y cinco veces la misma información, por el simple hecho de que consideraban que el abrir una nueva pestaña y buscar cuatro palabras clave era más eficiente que tomarse el tiempo de anotar la información que encontraron cuando realizaron la búsqueda la primera vez.

La percepción general sobre la acción de documentar

Cuando digo “documentar” me refiero tanto a la acción de recoger información y guardarla de forma inalterable en algún lugar, como a desarrollar una documentación sobre una tarea, proceso, código de programación o cualquier otro asunto que pueda requerir de ello.

Es innegable que generar documentación es “lo aburrido”, lo que nadie quiere hacer. Básicamente, porque se tiene la percepción de que el documentar algo está separado o alejado de la tarea que se está realizando.

Archivadores

Las ventajas de documentar los cambios web

Comparto las que, a mi parecer, son las principales ventajas de documentar el trabajo de desarrollo web:

  1. La primera de todas es que se puede contextualizar la información que se ha encontrado: una mínima descripción sobre el problema y en qué contexto se aplica la solución o información encontrada puede ayudar en un futuro a volver a utilizar dicha información o descartarla simplemente echando un vistazo a la información de contexto.

  2. Ahorramos tiempo al poder discernir en un momento si se puede parar de buscar en ese momento o hay que obviar dicha solución e una nueva búsqueda. Además, la “meta información” que se recoge en forma de contexto permite ampliar el alcance de los términos de búsqueda que se utilicen en el sistema de información.

  3. Otra de las ventajas de contextualizar la información es que se podrán recoger todos los detalles a tener en cuenta para poder utilizarla o aplicarla de nuevo. En ocasiones, una solución encontrada depende de realizar una serie de pasos previos, o de preparar un entorno específico. Si no se hace así, después de un tiempo será muy probable que dichos detalles se olviden.

  4. En el caso de los procesos o la realización de tareas, documentar nos ayuda a reproducir exactamente los pasos que se han de dar para llegar a una solución efectiva. De nuevo, quiero hacer hincapié en que de esta forma no se olvidarán los detalles que pueden hacer que un proceso falle.

  5. Si existe la posibilidad de compartir esta información, los agentes que se enfrenten a estos procesos por primera vez puedan seguirlos de forma exhaustiva, para la satisfactoria consecución de la tarea que se le ha asignado.

  6. Evitar el problema del constante cambio de Internet. Al guardar una copia de la información, no importa que dicho recurso online desaparezca, ya que se dispondrá de una copia —ya sea local o en la nube— a la que poder referirse siempre, dentro del sistema de información. Aquí se genera la reflexión de las ventajas y desventajas de tener un sistema de información en la nube o en local, pero es una reflexión que creo atañe realizar a cada persona, y valorar dónde decide guardar su información y porqué.

  7. Comprender más profundamente aquello sobre lo que se documenta. El proceso de generar documentación requiere una síntesis del problema y la solución para documentar el contexto, que puede incluso llegar a ayudar a la persona a darse cuenta de que la información recogida es insuficiente o quizás no es aplicable en dicho contexto.

Conclusión

Por lo tanto, en mi opinión, documentar no sólo nos ayuda en el aspecto de ahorro de tiempo en un futuro, sino también en profundizar en el problema y ayudar a comprenderlo mejor. Además, como ya he comentado, puede incluso ayudarnos a centrarnos en otras cosas mientras remitimos dichos documentos a personas que nos han pedido ayuda. De esta forma, si más adelante tenemos dudas, podremos partir de una base en la que la otra persona ya está dentro de un contexto, sin tener que explicarle todo el proyecto desde el principio.

Mikel Alejo Barcina Ribera

Web Software Engineer en GuGo Creative

Créditos

Compartir Post

  • facebook
  • twitter

Este sitio web utiliza cookies propias y de terceros. Si continua navegando en esta Web, se entenderá que está de acuerdo con dicha política de cookies.