Plantillas de especificaciones técnicas y funcionales [cerrado]

Question

Básicamente, estoy buscando buenas plantillas para escribir especificaciones técnicas y funcionales en un proyecto o solicitud de trabajo.

¿Que usas?¿Qué tan profundo llegas al escribir las especificaciones?Se agradecería cualquier consejo general adicional que pudiera proporcionar.

Mi empresa los necesita urgentemente.Trabajo para un contratista y ahora mismo no utilizamos estos documentos en absoluto.

EDITAR: He leído la opinión de Joel sobre Especificación indolora, Me gustó mucho, pero ¿hay alguna otra opinión? :)

Answer 1

Sobre consejos generales;

Estamos implementando un proceso de

1) Declaración de requisitos comerciales (BRS)

2) Especificación funcional

3) Especificaciones técnicas

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

La especificación funcional detalla lo que se necesita, cómo debe verse, qué tan largos deben ser los campos, etc.

Las especificaciones técnicas detallan de dónde provienen los datos y cualquier código complicado que deba tenerse en cuenta.

El cliente es dueño de los requisitos.Los desarrolladores son dueños de las especificaciones técnicas y las especificaciones funcionales son un término medio.Las pruebas se realizan según las especificaciones técnicas (normalmente pruebas unitarias), luego según las especificaciones funcionales (normalmente pruebas del sistema) y luego según los requisitos (UAT).

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

En resumen, mi consejo principal es que primero calcules el proceso que deseas implementar.Luego busque el acuerdo de todas las partes involucradas en el proceso propuesto y luego trabaje en las plantillas que se ajusten.Las plantillas en sí son sólo una pequeña parte del cambio que desea realizar.

Answer 2

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

Answer 3

Puedes comprar plantillas en ieee y en otros lugares, pero yo siempre termino haciendo las mías propias.

Para una especificación técnica, "Código completo" de Steve McDonnell tiene una buena lista de verificación, puedes extraer algo de información de ella.En mi último trabajo, simplemente hice una plantilla con los encabezados de sus secciones y la modifiqué desde allí.

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

1. UI (maquetas de pantalla)
2. Interfaces de software (complementos, etc.)
3. Interfaces de hardware (si corresponde)
4. Interfaces de comunicaciones (Servicios, correo electrónico, mensajería, etc.)

También debería haber una sección para reglas comerciales, cosas que son importantes desde el punto de vista funcional y que no están cubiertas en ninguna definición de interfaz.

Answer 4

Si quieres comprar un libro, Requisitos de software por 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 quizás pueda confirmarlo.

Answer 5

Me gusta este, entre otros: En sus marcas, listos.

También vende una versión pro.

Answer 6

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

Answer 7

Comience de manera simple y avance desde allí.Dado que esta es su primera experiencia trabajando con esto, utilice un documento de Word con viñetas.Escríbalo, vuelva a leerlo y proporcione suficientes detalles 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" debería faltar por completo.

Answer 8

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 les daré algunos de los encabezados principales:

1. El propósito del proyecto
2. Las partes interesadas
3. Restricciones obligatorias
4. Convenciones de nomenclatura y terminología
5. Hechos y supuestos relevantes
6. El alcance del trabajo
7. Modelo de datos empresariales y diccionario de datos
8. El alcance del producto
9. Requerimientos funcionales
10. Mira y siente requisitos ...

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.Nuevamente protegido por derechos de autor, pero verdaderamente valioso.

Mirar aquí en el capítulo 9.