Génie logiciel documentation

1

quel type de système de documentation technique en ligne recommanderiez-vous? [fermé]

Fermé . Cette question est basée sur l'opinion . Il n'accepte pas actuellement les 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 . l'objectif est d'avoir un système …

11 documentation

5

Un document de description d'architecture constitue-t-il une violation du principe DRY?

Le principe DRY (Don't Repeat Yourself) stipule que «chaque élément de connaissance doit avoir une représentation unique, non ambiguë et faisant autorité au sein d'un système». La plupart du temps, cela fait référence au code, mais il est souvent étendu à la documentation également. On dit que chaque système logiciel …

11 agile documentation architecture dry

5

Modèles / exigences de proposition de projet [fermé]

Dans l'état actuel des choses, cette question ne convient pas à notre format de questions / réponses. Nous nous attendons à ce que les réponses soient étayées par des faits, des références ou une expertise, mais cette question suscitera probablement un débat, des arguments, des sondages ou une discussion approfondie. …

11 project-management business management documentation

4

Meilleure pratique pour marquer une méthode appelée par réflexion?

Notre logiciel a plusieurs classes qui devraient être trouvées dynamiquement via la réflexion. Les classes ont toutes un constructeur avec une signature spécifique via laquelle le code de réflexion instancie les objets. Cependant, lorsque quelqu'un vérifie si la méthode est référencée (par exemple via Visual studio Code Lens), la référence …

11 c# .net documentation reflection

6

Les commentaires sont-ils considérés comme une forme de documentation?

Lorsque j'écris de petits scripts pour moi-même, j'empile mon code avec des commentaires (parfois je commente plus que je code). Beaucoup de gens à qui je parle disent que je devrais documenter ces scripts, même s'ils sont personnels, de sorte que si je les vendais, je serais prêt. Mais les …

11 documentation comments

3

Écriture de commentaires Java Doc pour les cas de tests unitaires

À mon avis, les cas de tests unitaires servent eux-mêmes de documentation pour le code. Mon entreprise veut que j'écrive des commentaires détaillés sur le doc java sur les tests élémentaires. Est-il nécessaire de le faire? Écrivez-vous des commentaires comme ça?

11 unit-testing documentation

4

Inclure un lien vers la documentation pertinente dans le message d'erreur?

Nous créons une bibliothèque commerciale et des exemples de code qui sont utilisés par des développeurs externes. Nous avons une documentation (fermée, disponible pour les utilisateurs enregistrés) qui explique en détail comment utiliser la bibliothèque. Beaucoup de développeurs sont de nouveaux utilisateurs, donc beaucoup d'erreurs rudimentaires sont rencontrées. Est-il approprié …

10 documentation api-design error-handling error-messages

4

Existe-t-il une norme pour documenter l'architecture de haut niveau d'un programme?

Je suis un développeur amateur et tous mes programmes jusqu'à présent étaient assez simples pour être documentés dans le code. En lisant le code, il était clair ce que je faisais telle ou telle action (mon test standard consistait à regarder le code 6 mois plus tard et à tout …

10 architecture documentation

5

Utilisation de modèles différents pour des fonctionnalités similaires

Je suis le seul développeur d'un projet qui, comme tout projet logiciel, pourrait être repris par quelqu'un d'autre à l'avenir. Disons que j'ai utilisé le modèle X pour implémenter la fonctionnalité A. Après avoir développé et terminé la fonctionnalité, je me rends compte que je pouvais implémenter la même fonctionnalité …

10 design-patterns refactoring documentation

1

Quelles informations devraient figurer dans le github README.md?

Quelles informations vous attendez-vous à voir dans le github README? Tout devrait-il aller dans le README? c'est à dire introduction Installation Versions Mode d'emploi la mise en oeuvre Essai Ressources associées Ou devriez-vous simplement mettre certaines choses dans le README (Introduction, Installation, Versions) et les autres informations sont mieux placées …

10 documentation github

3

Les commentaires XML sont-ils une documentation nécessaire?

J'étais un fan d'exiger des commentaires XML pour la documentation. J'ai depuis changé d'avis pour deux raisons principales: Comme un bon code, les méthodes doivent être explicites. En pratique, la plupart des commentaires XML sont des bruits inutiles qui n'apportent aucune valeur supplémentaire. Plusieurs fois, nous utilisons simplement GhostDoc pour …

10 .net programming-practices development-process documentation comments

5

Est-ce une bonne idée d'écrire les spécifications des exigences par histoires?

Nous utilisons actuellement des méthodes agiles dans mon projet actuel, et nous avons des tas d'histoires comme celles-ci: En tant qu'assistante, je veux rembourser un client afin qu'il puisse obtenir un peu d'argent quand il le demande En tant que client, je souhaite régler un achat afin de pouvoir recevoir …

10 agile documentation requirements user-story

5

Déterminer la bonne quantité de documentation

Là où je travaille actuellement, l'approche générale est - éviter autant que possible la documentation Documenter uniquement si une autre équipe en a besoin juste pour clarification, je ne parle pas de documentation de code - ce que nous faisons, je veux dire toute la documentation entourant le processus de …

10 documentation

5

Meilleure façon de former de nouveaux employés [fermé]

Fermé . Cette question doit être plus ciblée . Il n'accepte pas actuellement les réponses. Voulez-vous améliorer cette question? Mettez à jour la question afin qu'elle se concentre sur un problème uniquement en modifiant ce message . Fermé il y a 5 ans . L'équipe dont je fais partie fait …

10 documentation training

5

Un commentaire de méthode doit-il inclure à la fois un résumé et une description de retour alors qu'ils sont souvent si similaires?

Je suis un partisan du code correctement documenté, et je suis bien conscient des inconvénients possibles de celui-ci . Cela sort du cadre de cette question. J'aime suivre la règle consistant à ajouter des commentaires XML pour chaque membre public, compte tenu de mon intérêt pour IntelliSense dans Visual Studio. …

10 documentation comments intellisense

Questions marquées «documentation»