Outils et normes pour la conception technique document

Question

Je voudrais savoir quels sont les outils et les normes que mes collègues utilisent pour les documents de conception technique de nos jours. Par le passé, lorsque nous ne fournissions que des applications win-apps client-serveur, nous avions des modèles de mots pour nos documents de conception. Nos modèles ont toujours commencé avec le diagramme de base de données, puis les maquettes d'interface utilisateur, les mappages de champs, la description de la fonctionnalité, etc ... Avec Word et Visio, nous en avions assez. Mais dernièrement, nous combinons des wikis, des diagrammes UML, des outils de prototypage, etc ... Sans politique vraiment forte pour les standards et les outils. Pensez-vous qu'il est bon de donner aux architectes la liberté de choisir l'ensemble des outils et des normes qu'ils jugent appropriés à un moment donné par projet ou est-ce que l'entreprise devrait les appliquer et les normaliser?

Answer 1

La raison derrière toute documentation de conception est une communication claire à toutes les personnes impliquées. Ainsi, de ce point de vue, quels que soient les outils que vous choisissez en tant qu'architecte, le produit fini doit être lu à la fois par tous les intervenants, et plus tard par les responsables. Il est donc logique de sélectionner au moins quelques outils assez standards, qui seront encore disponibles dans quelques années. Cela dit, les documents de conception sont généralement utilisés pour mettre le projet ou le système en service. Par la suite, un code bien documenté et quelques documents de base devraient suffire. Je ferais probablement plus attention à l'organisation de votre documentation, afin que les gens puissent facilement trouver ce qu'ils cherchent dans le futur. Cela peut aider à mettre en place une structure/un système de référentiel standard pour stocker la documentation, mais n'insistez pas nécessairement sur toutes sortes de modèles pour la documentation. Concentrez-vous sur le contenu et non sur les outils.

Answer 2

À moins que vos projets ne soient des emporte-pièces, il est logique d'appliquer la meilleure combinaison d'outils pour le travail en cours. Cela dit, certaines normes approximatives (lignes directrices approximatives) ou étroites (appliquées à des circonstances particulières) sont probablement justifiées.

Answer 3

Une discussion approfondie entre les développeurs principaux ou les membres de l'équipe (éventuellement enregistrée pour plus tard) est beaucoup plus utile que n'importe quel document, à mon avis. Donnez-leur toute la liberté de choisir leurs outils et demandez-leur seulement d'écrire un bref résumé des décisions techniques de haut niveau dès le début. Cela peut être le fondement de la documentation plus tard dans le projet. Un document de conception technique devient obsolète trop tôt et prend trop de temps à écrire.

Answer 4

Je pense qu'il devrait y avoir un ensemble d'outils et de normes qui sont spécifiés au moment de l'architecture qui décrit comment la conception doit être documentée. Il est vraiment important d'avoir une norme pour documenter ces choses; autrement, ils ont tendance à tomber au bord du chemin; et si la documentation de conception est hétérogène, il y a un risque que les personnes qui ont vraiment besoin d'en savoir plus sur la conception ne soient pas en mesure de trouver les informations de conception dont elles ont vraiment besoin quand elles en ont vraiment besoin.

Cela dit, le choix des outils et des normes dépend entièrement de chaque organisation différente; tout ce qui fonctionne pour une organisation est bon pour eux. Tant qu'il y a uniformité dans les normes (et les outils, dans une certaine mesure), tout ce qui est choisi pour une organisation individuelle est bon pour eux. Il a juste besoin d'être décidé et appliqué.