2008-09-09 5 views
60

Donc, fondamentalement, je suis à la recherche de bons modèles pour écrire les spécifications techniques et fonctionnelles sur un projet ou une demande de travail.Modèles de spécifications techniques et fonctionnelles

Qu'est-ce que vous utilisez? Quelle profondeur obtenez-vous en écrivant les spécifications? Tous les conseils généraux supplémentaires que vous pourriez fournir seraient appréciés.

Ma société en a grandement besoin. Je travaille pour un entrepreneur et pour l'instant nous n'utilisons pas ces documents du tout.

EDIT: J'ai lu prendre de Joel à propos Painless Specification, j'ai vraiment aimé, mais sont-il d'autres opinions :)

Répondre

31

Sur des conseils généraux;

Nous mettons en œuvre un processus de

1) Exigences d'affaires Déclaration (BRS)

2) Spécifications fonctionnelles

3) Caractéristiques techniques

La BRS couvre ce que les problèmes de l'entreprise sont et quelles sont les exigences en matière de solutions, de tests, de sécurité, de fiabilité et de livraison. Ceci définit ce qui ferait une solution réussie.

Les détails de spécifications fonctionnelles ce qui est nécessaire, comment il devrait ressembler, combien de temps les champs doivent être, etc.

Les détails de spécifications techniques où les données proviennent, tout code délicat qui peut devoir être pris en considération.

Le client est propriétaire des exigences. Les développeurs possèdent les spécifications techniques et la spécification fonctionnelle est un terrain d'entente. Les tests sont effectués en fonction des spécifications techniques (généralement des tests unitaires), puis contre les spécifications fonctionnelles (généralement les tests système), puis contre les exigences (UAT). La partie importante de ceci (et nous luttons avec) est que les développeurs doivent toujours livrer aux spécifications fonctionnelles, et aux conditions d'affaires originales. En réalité, les spécifications fonctionnelles et techniques sont juste là pour plus de clarté. En bref, mon astuce principale est d'abord d'élaborer le processus que vous souhaitez mettre en œuvre. Ensuite, demandez l'accord de toutes les parties impliquées dans votre processus proposé, puis travaillez sur les modèles pour les adapter. Les modèles eux-mêmes sont seulement une petite partie du changement que vous voulez faire.

6

Si vous voulez acheter un livre, Software Requirements by Karl Wiegers a des modèles pour quelques documents en tant que annexe. Malheureusement, je suis au travail et ce livre particulier est à la maison. Si quelqu'un l'a à portée de main, ils pourraient être en mesure de confirmer cela.

7

Vous pouvez acheter des modèles chez ieee et d'autres endroits, mais j'ai toujours fini par faire les miens.

Pour une spécification technique, "Code Complete" par Steve McDonnell a une bonne liste de vérification, vous pouvez tirer quelques informations à partir de cela. Lors de mon dernier travail, j'ai juste fait un gabarit à partir de ses en-têtes de section, et l'ai ajusté à partir de là.

En ce qui concerne une spécification fonctionnelle, l'important est de définir toutes les interfaces:

  1. UI (maquettes d'écran)
  2. interfaces logicielles (plugins, etc.)
  3. interfaces matérielles (si appropriés)
  4. interfaces de communication (services, courrier électronique, messagerie, etc.)

Il devrait également y avoir une section pour les règles métier, les éléments importants sur le plan fonctionnel qui ne sont couverts par aucune définition d'interface.

5

Il m'arrive d'aimer celui-ci, entre autres: ReadySet.

Il vend aussi une version pro.

3

Commencez simplement, et continuez votre chemin à partir de là. Puisque c'est votre première expérience de travail, utilisez un document Word avec des puces. Ecrivez-le, relisez-le et fournissez suffisamment de détails pour qu'il soit logique. Pour les spécifications techniques, vous pouvez diriger le développeur vers une solution, mais pour les spécifications fonctionnelles, le "comment" devrait être complètement absent.

3

Je suggère de jeter un coup d'oeil au modèle Volere de Roberston here. Ils font partie de la Atlantic Systems Guild, avec des gens comme Tom DeMarco et Timothy Lister de la célébrité "Peopleware".

Comme le modèle est protégé par copyright, je ne reproduirai pas ici, mais vous donner quelques-unes des principales têtes:

  1. Le but du projet
  2. Les parties prenantes
  3. Contraintes Mandated
  4. Conventions de nommage et terminologie
  5. Faits et hypothèses pertinents
  6. La portée de l'œuvre
  7. Modèle de données d'entreprise et dictionnaire de données
  8. La portée du produit
  9. Exigences fonctionnelles
  10. Look et FEELS Exigences ...

Il y a beaucoup plus, mais cela devrait vous donner un idée. La partie la plus intéressante du modèle est le shell des exigences qui répertorie les exigences fonctionnelles sur un type de carte de repère. Toujours sous copyright, mais vraiment précieux.

Regardez here au chapitre 9.