¿Cuáles son algunos recursos para aprender a escribir especificaciones?

Question

En el trabajo soy responsable de redactar las especificaciones con bastante frecuencia y también soy la persona que insistió en obtener las especificaciones en primer lugar.El problema es que no estoy seguro de cómo deberían verse las especificaciones y qué deberían contener.Muchas veces, cuando mi jefe escribe las especificaciones (ambos no tenemos experiencia en ello), ponen nombres de tablas y cosas que no creo que pertenezcan allí.Entonces, ¿cuál es una buena manera de aprender a escribir una buena especificación?

EDITAR:¿Una especificación funcional debería incluir cosas como asumir que estoy especificando una aplicación web, los tipos de entrada (un cuadro de texto, una lista desplegable, etc.)?

Answer 1

La parte más importante de la documentación de desarrollo, en mi opinión, es que lo haga la persona correcta.

• Documentos de requisitos: usuarios + analista de negocios
• Especificaciones funcionales - Analista de negocios + desarrollador
• Especificaciones técnicas (cómo se implementará realmente la funcionalidad) - Sr.Desarrollador / arquitecto
• Estimaciones de tiempo para propósitos de programación - El desarrollador específico asignado a la tarea

Tener a alguien además del Sr.El desarrollador/arquitecto define estructuras/interfaces de tablas, etc.es un ejercicio inútil, ya que el desarrollador más experimentado generalmente descartará la mayor parte.

Wikipedia es en realidad un buen comienzo para la especificación funcional, que parece similar a su especificación. http://en.wikipedia.org/wiki/Functional_specification.

Answer 2

Hay un gran capítulo en el libro de Steve McConnell. Código completo que recorre los documentos de especificaciones y lo que deben contener.

Cuando me encargaron crear un equipo de Arquitectura y Análisis de Negocios en una empresa que nunca había tenido ninguna de las dos cosas, utilicé el capítulo de especificaciones de McConnell para crear el esquema del documento de Especificaciones Técnicas.Evolucionó con el tiempo, pero al comenzar con este marco me aseguré de que no nos perdiéramos nada y resultó ser sorprendentemente utilizable.

Al redactar especificaciones, una regla general que sigo es tratar de que los documentos técnicos siempre comiencen desde lo general y pasen a lo específico: siempre replantee los problemas u objetivos comerciales para los que se está desarrollando la solución técnica. resolver, por lo que la persona que lee la especificación no necesita ir a otros documentos para ponerla en ningún tipo de contexto.

Answer 3

Ver Especificaciones funcionales indoloras Por Joel Spolsky.

Algunas de las cosas que, según él, debería tener toda especificación:

• un descargo de responsabilidad
• Un autor.un autor
• Escenarios
• No objetivos
• Una descripción general
• Detalles, detalles, detalles
• Problemas abiertos
• Notas al margen

Answer 4

Lo importante es escribir algo en lugar de preocuparse por el formato.

Answer 5

Comprar libros:Ingeniería de requisitos por Ian Sommerville y Pete Sawyer ISBN 0-471-97444-7 o requisitos de software por Karl Wiegers ISBN 0-7356-0631-5