Plantillas de Especificaciones Técnicas y Funcionales [cerrado]


Así que básicamente estoy buscando buenas plantillas para escribir especificaciones técnicas y funcionales en un proyecto o solicitud de trabajo.

¿Qué usas? ¿Qué tan profundo se obtiene al escribir las especificaciones? Cualquier consejo general adicional que pueda proporcionar será apreciado.

Mi compañía los necesita urgentemente. Trabajo para un contratista y en este momento no usamos estos documentos en absoluto.

EDITAR: He leído la toma de Joel sobre Especificación indolora , realmente me gustó lo, pero hay otras opiniones:)

Author: Montag451, 2008-09-09

8 answers

En consejos generales;

Estamos implementando un proceso de

1) Declaración de Requisitos Comerciales (BRS)

2) Especificación funcional

3) Especificación técnica

El BRS cubre cuáles son los problemas de negocio y cuáles son los requisitos en torno a soluciones, pruebas, seguridad, confiabilidad y entrega. Esto define lo que haría una solución exitosa.

La especificación funcional detalla lo que se necesita, cómo debe verse, cuánto deben ser los campos be, etc.

La especificación técnica detalla de dónde provienen los datos, cualquier código complicado que pueda necesitar ser considerado.

El cliente posee los requisitos. Los desarrolladores son dueños de las especificaciones técnicas, y la especificación funcional es un punto medio. Las pruebas se realizan contra las especificaciones técnicas (generalmente pruebas unitarias), luego contra las especificaciones funcionales (generalmente pruebas del sistema) y luego contra los requisitos (UAT).

La parte importante de esto (y con la que estamos luchando) es que los desarrolladores todavía necesitan cumplir con las especificaciones funcionales y los requisitos comerciales originales. En realidad, las especificaciones funcionales y técnicas solo están ahí para la claridad.

En resumen, mi consejo principal es primero elaborar el proceso que desea implementar. Luego busque el acuerdo de todas las partes involucradas en su proceso propuesto, luego trabaje en las plantillas para que se ajusten. Las plantillas en sí son solo una pequeña parte del cambio que desea hacer.

 31
Author: Mark Nold,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2014-06-18 13:03:14

No es una plantilla, pero Joel ha escrito un par de artículos sobre escribir una especificación funcional. También tiene muestra aquí.

 17
Author: Galwegian,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2008-09-09 16:40:02

Puedes comprar plantillas de ieee y otros lugares, pero siempre he terminado haciendo las mías.

Para una especificación técnica, "Code Complete" de Steve McDonnell tiene una buena lista de verificación, puede extraer información de eso. En mi último trabajo, solo hice una plantilla con los encabezados de sus secciones, y la ajusté desde allí.

En cuanto a una especificación funcional, lo importante es definir todas las interfaces:

  1. Interfaz de usuario (maquetas de pantalla)
  2. Interfaces de software (plugins, sucesivamente.)
  3. Interfaces de hardware (si procede)
  4. Interfaces de comunicaciones (Servicios, correo electrónico, mensajería, etc.)

También debería haber una sección para reglas de negocio, cosas que son importantes funcionalmente que no están cubiertas en ninguna definición de interfaz.

 7
Author: Guy Starbuck,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2008-09-09 16:39:31

Si desea comprar un libro, Software Requirements by Karl Wiegers tiene plantillas para algunos documentos como apéndice. Desafortunadamente, estoy en el trabajo y ese libro en particular está en casa. Si alguien lo tiene a mano, podría confirmarlo.

 6
Author: Thomas Owens,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2008-09-09 16:43:32

Resulta que me gusta este, entre otros: ReadySet.

También vende una versión pro.

 5
Author: Ben Collins,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2008-09-09 16:56:30

Este es el mejor que he encontrado: http://www.jiludwig.com/templates/FRDTemplate.doc

 5
Author: webdev5,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2015-08-24 15:39:39

Comience de manera simple, y trabaje a partir de ahí. Ya que esta es su primera experiencia trabajando con esto, use un documento de Word con viñetas. Escríbalo, vuelva a leerlo y proporcione suficiente detalle para que tenga sentido. Para las especificaciones técnicas, es posible que desee guiar al desarrollador hacia una solución, pero para las especificaciones funcionales el "cómo" debe faltar por completo.

 3
Author: srclontz,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2008-09-09 17:40:39

Sugeriría echar un vistazo a la plantilla Volere de Roberston aquí. Son parte del Atlantic Systems Guild, junto con personas como Tom DeMarco y Timothy Lister de la fama de "Peopleware".

Como la plantilla tiene derechos de autor, no la reproduciré aquí, pero le daré algunos de los encabezados principales:

  1. El Propósito del Proyecto
  2. Las Partes interesadas
  3. Restricciones impuestas
  4. Convenciones de nomenclatura y Terminología
  5. Hechos Relevantes y Supuestos
  6. El Alcance del Trabajo
  7. Modelo de Datos de Negocio y Diccionario de Datos
  8. Definición del producto
  9. Requisitos funcionales
  10. Requisitos de Apariencia y Sensación ...

Hay muchos más, pero esto debería darte una idea. La parte más interesante de la plantilla es el shell de requisitos que enumera los requisitos funcionales en una especie de tarjeta de referencia. De nuevo con derechos de autor, pero verdaderamente valioso.

Mira aquí en el capítulo 9.

 3
Author: Ralph M. Rickenbach,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2015-08-25 05:39:30