Quelle est la bonne façon de créer des documents d'exigences?

softwareengineering.stackexchange https://softwareengineering.stackexchange.com/questions/9371

Question

En ce moment, mon superviseur crée la documentation des exigences / spécifications pour moi en utilisant le logiciel. bugtracking Cela semble être une idée terrible pour moi, toutes les exigences sont sur ces petits billets et je dois cliquer autour de ce formulaire en ligne pour obtenir stupide aux exigences. Qu'est-ce qu'une solution logicielle saine d'esprit pour les besoins / spécifications logicielles?

Pour être clair, je suis la construction de ce grand composant logiciel avec quelques fonctionnalités et ces caractéristiques sont reconnus dans ce logiciel de suivi des bogues.

Était-ce utile?

La solution

Je suis plutôt surpris que personne à ce jour a recommandé l'utilisation d'un wiki pour les besoins de suivi.

Je l'ai trouvé, d'un système presque parfait, parce que:

  • Il permet aux gens de collaborer sur les exigences et rend cet aspect très visible;
  • Il vous permet de garder facilement les exigences à jour que les progrès du projet;
  • Vous pouvez aller voir l'histoire à tout moment, en cas de « ce n'est pas ce que nous avons convenu » différend;
  • La plupart des wikis modernes ont des capacités de formatage décentes, donc il semble presque aussi bon que d'un document Word;
  • Vous pouvez directement un lien hypertexte de vos besoins dans la documentation réelle;
  • Vous avez jamais à vous soucier des gens qui travaillent hors de différents / copies obsolètes;
  • Les exigences peuvent commencer à être traité comme un processus itératif, tout comme la conception / mise en œuvre;
  • Si les conditions commencent à devenir vraiment grand / compliqué, il est facile de les diviser sur plusieurs pages / sujets.
  • La plupart des wikis acceptent HTML, donc si vous avez vraiment besoin de mise en forme avancée, vous pouvez probablement utiliser un outil comme de Windows live Writer.

Étant donné le choix, je presque toujours choisir la méthode wiki ces jours-ci, il est indolore vraiment par rapport aux documents Word l'ancienne ou essayer de caser tout dans un bug tracker.

Autres conseils

J'utilise toujours la norme IEEE 830-1998 (IEEE pratique recommandée pour les exigences logicielles specifcations) comme modèle pour mon document SRS. Voir http://standards.ieee.org/reading/ieee/std_public/description /se/830-1998_desc.html

Le SRS document final lui-même est généralement un seul document OpenOffice.org, mais il y a généralement beaucoup de parties constitutives qui vont dans, y compris des feuilles de calcul et des diagrammes.

Je mets habituellement tous ces documents ensemble dans un dépôt que je mets dans un système contrôle de révision , comme SVN ou CVS. Tous les autres analystes, concepteurs, développeurs, testeurs, chefs de projet et clients ont accès à ce dépôt, afin qu'ils puissent le lire et apporter des modifications.

Rappelez-vous, le SRS est un document vivant, en constante évolution. Il continuera de changer et de croître pendant un certain temps. Non seulement il est important que toutes les parties prenantes d'avoir accès aux SRS, mais c'est aussi important d'avoir une histoire complète des changements, et la capacité de rollback ces changements et, le cas échéant. Ainsi, un système de contrôle de révision fonctionne très bien à cette fin. Bonne chance!

Utilisation du bug-tracker pour la gestion des exigences a une tendance à cacher le manque de collaboration et la communication au sein de l'entreprise.

Sans porter un jugement sur une méthode particulière:

  • si vous allez utiliser la cascade, vous avez besoin bien structuré, précis, documents de plusieurs pages (pas un paragraphe que beaucoup de gens de type généralement comme une description de bug). Ces documents sont également impossible d'écrire et de maintenir à un niveau décent de qualité si le marketing / vendeurs (qui proviennent des exigences) ne fonctionnent pas bien ensemble avec le personnel technique.
  • si vous allez utiliser l'une des méthodes agiles, puis une unité de besoins est une histoire d'utilisateur, représenté par une carte d'histoire. La carte elle-même est pas une exigence, seulement un point de départ de la conversation.

A (brève) expérience d'un de mes anciens employeurs à l'aide d'un bug-tracker pour les besoins était qu'il a donné beaucoup de gens comme un moyen très facile de cesser de communiquer complètement. Les gens tout simplement écrire un souhait, le jeter dans le bug-tracker, et supposons qu'il finirait par se réaliser.

Bien sûr, ils l'ont fait sans tenir compte de:

  • leurs propres qualifications
  • leur participation dans le projet
  • les conflits avec d'autres exigences
  • les lacunes dans les exigences
  • coûts
  • toutes les considérations techniques
  • etc.

Je crois que les documents « Word » sont le mauvais chemin à parcourir pour les besoins, pour les raisons suivantes:

  1. Pas moyen de "diff" deux documents pour voir ce qui a changé.
  2. L'interface utilisateur dissuade l'aide d'un style cohérent tout au long. Oui, à l'aide de styles peut être fait, mais la plupart des gens ne peuvent pas être pris la peine en raison de la difficulté.
  3. Format de document est essentiellement caché. Bien sûr, il y a une spécification pour les fichiers OLE, que je suppose « Word » docs sont, mais Microsoft a enterré tout utile sous des tonnes de baratin, donc personne ne sait vraiment. Tôt ou tard, votre brillant, nouveau « Word » ne sera pas ouvrir le document.
  4. ne joue pas bien avec d'autres formats. C'est, sauf si vous utilisez Windows et IE, vous êtes hors de la chance si quelqu'un a organisé les documents d'un projet dans les fichiers HTML avec des liens vers des fichiers de format « Word ». Cliquez sur le lien erroné, et vous devez assister à une longue période de téléchargement et démarrage Word, interrompant le flux de la pensée. Les liens hypertextes à partir des documents « Word » à d'autres peuvent ou peuvent ne pas fonctionner.
  5. « Word » est essentiellement pour les documents d'écriture destinés à apparaître sur le papier. Un but admirable, mais ce qui le rend moins utile pour l'affichage en ligne.

Je n'ai pas autre suggestion que j'ai l'expérience avec, mais je l'ai pensé restructurés Python Text ou Markdown comme des alternatives.

Nous utilisons généralement Word, mais en réalité, comment vous les créer dans le logiciel est moins important que la façon dont vous recueillir les données pour les créer et si la personne collecte de l'information connaît assez pour savoir quand une exigence est trop compliquée et sera beaucoup plus cher qu'une exigence plus simple ajouter encore de valeur réelle à tout le monde (par exemple quand ils veulent des numéros d'identification à toujours être attribués dans l'ordre avec aucun n'a jamais sauté) ou quand il sera en conflit avec une exigence existante ou une autre caractéristique prévue. Souvent, les utilisateurs réels sont jamais parlé et il y a beaucoup de surprises lorsque leurs gestionnaires ne savaient pas quelque chose qui devait absolument être fait et il n'est pas INTHE nouvelle version du logiciel.

Nous pouvons également utiliser différents fichiers PDF, Excel ou Visio ainsi. Tous pour le projet sont réunis et publiés sur SharePoint, afin que nous puissions voir les versions précédentes en cas de besoin.

Pour ma part, dans le passé, je l'ai utilisé des documents Word, mais ont décidé de trouver un outil à l'avenir pour gérer cela pour moi ... surtout avec la possibilité de bugs fixés aux exigences, parce que beaucoup de temps, le bug est dans les exigences, et non l'écart entre les spécifications et la mise en œuvre.

Il est même jamais me est venu d'utiliser un outil de suivi des bogues, mais il est logique totale.

Par curiosité, quel est-il à ce sujet que vous ne aimez pas?

EDIT: une mise en garde; dire à votre gestionnaire de rebaptiser le logiciel de suivi des bogues. Sinon, tout ce qu'il est supposé être un bug. J'ai eu ce problème politique à mon dernier client, où je mets des tâches dans le bug tracker. Pas bon.

J'ai écrit 6 ou 7 ans il y a une base de données de conditions requises pour gérer cela. Chaque enregistrement d'exigence a une courte description, une note de « définition », et une note de « notes » (texte riche, avec la possibilité de captures d'écran Embed, etc.). Il y a d'autres domaines aussi, pour le projet, livrable, numéro de séquence (ils peuvent être commandés logiquement), des cas d'utilisation / fonctionnalité, il est lié à, estimation du temps, un terrain pour la personne qui le manipule, si quelqu'un a choisi pour la mise en œuvre, etc.

Il y a aussi un « Etat » - « Entrée », car si nous concevons les caractéristiques; « Approuvé », fixé une fois un groupe d'exigences sont examinées et déterminé à être prêt à mettre en œuvre; « Mise en œuvre », fixé par le programmeur une fois qu'ils pensent que l'exigence se fait, et « Validé » une fois que la technologie d'assurance qualité est d'accord avec le programmeur. (Si les désapprouve tech d'assurance qualité, il peut le remettre à « Approuvé » pour que le programmeur obtient en arrière.) Les exigences peuvent aussi être « différée », « Rejeté » ou « Interrogée » (ce qui signifie la Commission de contrôle de changement doit regarder .)

L'astuce pour bien faire ce travail est granularité raisonnable. Il peut parfois logique d'avoir une des exigences de la phrase (par exemple « le problème décrit en cause est fixé 12345 »), mais en général, les exigences doivent décrire tous les aspects importants d'une caractéristique tout (ou une grande partie d'un). Par exemple, un type caractéristique « nouveau rapport » aura une exigence pour un format de rapport (ce que les regards de sortie comme), et une exigence pour les options (expliquant les champs, validation, etc.) Il pourrait même être un tiers si il y a un générateur complexe crissement les données, plutôt qu'une simple requête facile ou quelque chose. De plus, nous allons créer une exigence de « aide » pour la rubrique d'aide correspondante.

Il y a d'énormes avantages de garder ce genre de choses dans les documents de base de données plutôt que d'un gros document. Plusieurs programmeurs peuvent travailler sur les exigences en même temps. Les dossiers individuels sont verrouillés pour une seule personne peut éditer à la fois, mais ils peuvent être ouverts et lus pendant que quelqu'un d'autre est l'édition. Le plus grand avantage est cependant qu'il fournit facile de rechercher la documentation des deux quelles étaient les exigences et les notes sur la façon dont ils ont été mis en œuvre. Nous avons plus de 25 000 exigences là maintenant, et nous pouvons facilement trouver toutes les exigences avec des mots spécifiques dans tous les domaines, ou la définition, ou des notes, ou autre, en moins de 10 secondes. (Essayez cela avec 6 ans et la valeur de documents Word.)

Je ne vois pas pourquoi les gens pourraient dire que c'est une mauvaise idée de faire exigences dans un « bug tracker », mais je pense que ce parce que les outils sucent, non pas parce que garder les exigences dans une base de données est une mauvaise idée.

http://www.pivotaltracker.com/ mais dans mon entreprise actuelle, nous sommes en utilisant .doc comme source de spécification de base et Phare selon la liste de souhaits caractéristiques combinées et le suivi des problèmes. Pour moi, il est difficile de faire d'autres personnes dans l'équipe de commencer à utiliser d'autres outils quand ils sont tellement utilisés pour Word.

Si vous pouvez suivre la méthodologie Agile, les liens suivants peuvent vous guider dans le choix d'un bon outil de gestion de projet Agile:

Et sérieusement, essayez la méthodologie Agile - il prêche simple, élégant, sans fioritures, non jazzy, approche sensical commune dans tout ce que vous faites, de sorte que tous les membres de l'équipe comprend et apprécie le rôle et les efforts de tous les autres membres.

Bonne chance!

Licencié sous: CC-BY-SA avec attribution
scroll top