Je voudrais savoir quelles options sont disponibles pour documenter un projet qui a déjà été développé, car les développeurs qui ont travaillé n'ont pas écrit une seule page de documentation. Le projet n'a pas d'autres détails que de nombreuses pages de scripts avec des fonctions écrites et...
J'utilise actuellement deux systèmes pour écrire la documentation du code (j'utilise C ++): La documentation sur les méthodes et les membres de classe est ajoutée à côté du code, en utilisant le format Doxygen. Sur un serveur, Doxygen est exécuté sur les sources afin que la sortie soit visible dans...
Je suis actuellement en train de mettre à jour un document de conception afin qu'il soit correct et à jour pour les futurs développeurs. Actuellement, le document se concentre uniquement sur les faits et présente le design. Il n'y a aucune justification pour les décisions présentées. Je crois qu'il...
Pour élaborer, je suis intéressé à savoir ce que les gens pensent que vous devez mettre en place tout en étant un projet individuel (contrôle des sources d'équipe, documentation, builds, etc.) et quelles choses ne doivent pas être faites jusqu'à ce moment où la deuxième personne arrive sur le...
Nous utilisons actuellement un système appelé AsciiDoc qui nous permet de créer de la documentation dans un simple balisage de texte. À partir de cela, nous pouvons générer plusieurs formats de sortie. Nous utilisons uniquement les formats de sortie pdf et de sortie chm. Je me demandais s'il y...
Je me demande quelle serait la méthode officielle et la plus couramment utilisée pour documenter les règles commerciales? Aussi comment documentez-vous les spécifications de l'interface utilisateur des artefacts de développement (par exemple, la documentation des champs de formulaire et la façon...
Je suis un développeur de logiciels travaillant dans une entreprise de systèmes embarqués. Nous avons un chef de projet, qui s'occupe du calendrier global du projet (y compris électrique, qualité, logiciel et fabrication), donc son calendrier logiciel est très bref. Nous avons également un...
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 6 ans . Je suis le créateur d'un projet open source...
Existe-t-il un bon terme similaire mais différent de «obsolète» pour signifier qu'une méthode ou une API est dans la base de code mais ne doit pas être utilisée car son implémentation n'est pas complète ou va probablement changer? (Ouais, je sais, ces méthodes ne devraient pas être publiques, yada...
Je comprends la différence entre les deux, mais mes collègues m'interrogent sur l'intérêt des exigences d'étiquetage comme fonctionnelles ou non fonctionnelles (ou transitoires). Pourquoi se donner la peine de le faire? Il a passé ce qu'il a dit être deux jours à parcourir une liste d'exigences...
Important : nous n'avons aucun problème avec la documentation du code source . Cela appartient à l'audit de code régulier et est tenu à jour. Notre problème est avec la documentation des développeurs (ou, "externe" si vous le souhaitez), de petits conseils de programmeurs aux programmeurs qui ont...
W3Schools a la réputation d'être incomplet, parfois incorrect et rempli de publicité; malgré tout, lorsque vous cherchez à rechercher des éléments ou à créer un lien vers la documentation lorsque vous répondez à une question SO, il s'agit toujours de la seule ressource multi-navigateur pratique. Il...
Fermé . Cette question a besoin de détails ou de clarté . Il n'accepte pas actuellement les réponses. Voulez-vous améliorer cette question? Ajoutez des détails et clarifiez le problème en modifiant ce message . Fermé il y a 4 ans . RFC : La demande de commentaires (RFC) est un mémorandum publié...
Je dois documenter mon programme pour un projet d'école et nous avons une section intitulée «domaine à problème» mais je n'ai aucune idée de quoi discuter dans cette section. La question est donc la suivante: que faut-il discuter dans le domaine
Lorsque nous parlons de «documentation» pour un produit logiciel, qu'est-ce que cela inclut et qu'est-ce que cela ne devrait pas inclure? Par exemple, une question récente demandait si les commentaires sont considérés comme de la documentation? Mais il existe de nombreux autres domaines pour...
Nous examinons la refonte de la documentation sur notre gamme de produits. Une partie de cela comprend des manuels de référence pour un langage de programmation utilisé dans le cadre du système. Lors de la rédaction d'un manuel de référence pour un langage de programmation, quelle est la meilleure...
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 6 ans . Pour un projet, je dois travailler avec...
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 4 ans . Notre entreprise est sur le point...
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 4 ans . Chaque fois que j'ai terminé un projet, il y...
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 . J'ai lu récemment quelques propositions de...