Herramientas y estándares para el documento de diseño técnico

Question

Me gustaría saber qué herramientas y estándares están utilizando actualmente mis colegas para los documentos de diseño técnico.

En el pasado, cuando en mi empresa solo proporcionábamos aplicaciones ganadoras cliente-servidor, teníamos plantillas de palabras para nuestros documentos de diseño. Nuestras plantillas siempre comenzaron con el diagrama de la base de datos, luego las maquetas de UI, las asignaciones de campos, la descripción de la funcionalidad, etc. Con Word y Visio tuvimos suficiente. Pero últimamente estamos combinando wikis, diagramas UML, herramientas de creación de prototipos, etc. ... sin una política realmente sólida para estándares y herramientas. ¿Crees que es bueno darles a los arquitectos la libertad de elegir el conjunto de herramientas y estándares que consideren adecuados en un momento dado por proyecto o si la empresa debe hacer cumplir y estandarizar sobre esto?

Answer 1

La razón detrás de cualquier documentación de diseño es una comunicación clara para todos los involucrados. Entonces, desde ese punto de vista, independientemente de las herramientas que seleccione como arquitecto, el producto final debe leerse ahora por todos los involucrados y luego por los encargados del mantenimiento. Por lo tanto, tiene sentido seleccionar al menos algunas herramientas bastante estándar, que seguirán existiendo en unos pocos años.

Dicho esto, los documentos de diseño generalmente se utilizan para poner en marcha el proyecto o el sistema. A partir de entonces, el código bien documentado y algunos documentos básicos deberían ser suficientes. Probablemente prestaría más atención a la organización de su documentación, para que las personas puedan encontrar fácilmente lo que están buscando en el futuro. Puede ayudar a imponer algún tipo de estructura/sistema de depósito estándar para almacenar documentación, pero no necesariamente exige todo tipo de plantillas para la documentación. Enfóquese en el contenido y no en las herramientas.

Answer 2

A menos que sus proyectos sean cortadores de galletas, solo tiene sentido aplicar la mejor combinación de herramientas para el trabajo en cuestión. Dicho esto, algunas normas sueltas (pautas aproximadas) o estrechas (aplicadas a circunstancias específicas) probablemente estén justificadas.

Answer 3

Una discusión a fondo entre los desarrolladores principales o los miembros del equipo (posiblemente grabada para más adelante) es mucho más valiosa que cualquier documento, en mi opinión. Deles toda la libertad de elegir sus herramientas y pídales solo que escriban un breve resumen de las decisiones técnicas de alto nivel desde el principio. Esta puede ser la base de la documentación más adelante en el proyecto. Un documento de diseño técnico se desactualiza demasiado pronto y toma demasiado tiempo escribirlo.

Answer 4

Creo que debe haber un conjunto de herramientas y estándares que se especifiquen en el momento de la arquitectura que describa cómo debe documentarse el diseño. Es realmente importante tener un estándar para documentar estas cosas; de lo contrario, tienden a quedarse en el camino; y si la documentación de diseño es heterogénea, existe el peligro de que las personas que realmente necesitan saber más sobre el diseño no puedan encontrar la información de diseño que realmente necesitan cuando realmente la necesitan.

Dicho esto, la elección de herramientas y estándares depende totalmente de cada organización; lo que sea que funcione para una organización es lo correcto para ellos. Mientras haya uniformidad en los estándares (y las herramientas, hasta cierto punto), lo que se elija para una organización individual es lo correcto para ellos. Solo necesita decidirse e implementarse.