Quelles sont les spécifications techniques? Sont-ils les mêmes que les documents de conception. Si non, quelle est la différence et quelques
Je travaille en équipe sur une application existante dépourvue de documentation en ligne et de documentation technique. Pendant que je travaillais sur divers rapports de bogues sur l'application, j'ai écrit une sorte de fil d'Ariane - des numéros de bogues à divers endroits afin que le prochain...
Nous essayons de déplacer notre processus de documentation de projet de Google Documents vers un ensemble de référentiels Git auto-hébergés. Les documents texte sont assez compatibles avec Git, car nous n’avons généralement pas besoin d’un formatage sophistiqué, nous allons simplement tout...
Mon entreprise cherche à améliorer la gestion des données de ses études de marché. Style actuel de gestion des données: "Hé Jimbo, où est cette photo de notre WhatZit 2.0? "Oui, je me souviens de l'e-mail concernant cette société de ce type, donne-moi quelques minutes pour rechercher mes...
Je suis actuellement stagiaire chez un contractant gouvernemental et je ressens (ce qui est odieusement inévitable) que Word est la norme de facto dans le processus de développement de logiciels. Son format binaire rend très difficile la collaboration sur des documents comme je suis habitué à...
Quand les gens ont-ils commencé à écrire des fichiers Lisez-moi? Il semble que presque tous les programmes ont ce fichier, quel que soit le format. Y a-t-il une première utilisation documentée de ce
Il existe de bons exemples de code bien documenté, comme l'API Java. Mais, beaucoup de code dans les projets publics tels que git et les projets internes des entreprises est mal documenté et peu adapté aux nouveaux arrivants. Dans tous mes séjours de développement logiciel, j'ai dû faire face à du...
Sur mon lieu de travail, nous sommes confrontés à un défi dans la mesure où «agile» signifie trop souvent «exigences vagues, mauvais critères d'acceptation, bonne chance! Nous essayons de régler ce problème dans le cadre d'un effort d'amélioration général. Donc, dans le cadre de cela, je propose...
Le développement axé sur le comportement avec sa syntaxe emblématique de scénarios «Given-When-Then» a récemment été très médiatisé pour ses utilisations possibles en tant qu'objet frontière pour l'évaluation des fonctionnalités du logiciel. Je suis tout à fait d'accord pour dire que Gherkin , ou...
Pourquoi la documentation de certaines langues dit "équivalent à" plutôt que "est"? Par exemple, les documents Python disent itertools.chain(*iterables) ... Équivalent à: def chain(*iterables): # chain('ABC', 'DEF') --> A B C D E F for it in iterables: for element in it: yield element Ou cette...
Je travaille sur un projet depuis quelques années maintenant, et je commence à rassembler une base d'utilisateurs décente. J'ai créé une page de projet avec une documentation de base, mais ce n'est vraiment pas beaucoup plus qu'une FAQ à ce stade. Je sais que je dois l'améliorer afin qu'il soit...
Fermé . Cette question doit être plus ciblée . Il n'accepte pas actuellement de réponses. Voulez-vous améliorer cette question? Mettez à jour la question pour qu'elle se concentre sur un seul problème en modifiant ce post . Fermé l'année dernière . Je veux documenter mon code de telle sorte qu'il...
Cela semble un peu un sujet controversé de tout documenter, y compris la syntaxe "JavaBean" des getters et des setters pour les champs: les gens disent que sa rupture inutilement longue et répétitive DRY (ne vous répétez pas) , que la convention de nommage devrait tout expliquer , et il encombre le...
Je ne peux pas compter le nombre de fois que j'ai lu des déclarations dans la veine des «tests unitaires sont une source très importante de documentation du code testé». Je ne nie pas qu'elles soient vraies. Mais personnellement, je ne me suis jamais retrouvé à les utiliser comme documentation....
Nous rédigeons actuellement des spécifications fonctionnelles et techniques dans un format à deux colonnes; phrase sommaire et détail technique. Les détails se réfèrent souvent à une annexe avec des diagrammes, des schémas de configuration, etc. Cependant, je me bats avec quel temps l'écrire: Au...
Nous avons donc une interface comme ça /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff ///...
Contexte: Mes collaborateurs et moi écrivons un article pour une revue universitaire. Au cours de nos recherches, nous avons écrit un programme de simulation en Java. Nous voulons rendre le programme de simulation disponible gratuitement pour que d'autres puissent l'utiliser. Nous avons décidé...
Parfois, mais pas souvent, je dois inclure la logique mathématique dans mon code. Les concepts utilisés sont pour la plupart très simples, mais le code qui en résulte ne l'est pas - beaucoup de variables avec un but peu clair, et certaines opérations avec une intention pas si évidente. Je ne veux...
Fermé . Cette question est basée sur l'opinion . Il n'accepte pas actuellement de réponses. Voulez-vous améliorer cette question? Mettez à jour la question afin d'y répondre avec des faits et des citations en modifiant ce message . Fermé il y a 6 ans . Après avoir passé plus d'un an à travailler...
Récemment, j'ai travaillé sur la refactorisation de parties de la base de code que je traite actuellement - non seulement pour mieux le comprendre moi-même, mais aussi pour le rendre plus facile pour les autres qui travaillent sur le code. J'ai tendance à me pencher du côté de penser que le code...