Questions marquées «documentation»

La documentation du logiciel est un texte écrit qui accompagne les logiciels informatiques. Il explique comment le logiciel fonctionne, comment l'installer, comment l'utiliser et d'autres ressources d'aide.

7
Un document de conception doit-il contenir une discussion des avantages / inconvénients d'une conception donnée ou doit-il se concentrer sur les faits et la justification?
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 est …
7
Que dois-je inclure dans mon en-tête de documentation de classe
Je recherche un format de documentation de classe informatif pour mes classes Entité, Logique d'entreprise et Accès aux données. J'ai trouvé deux formats d' ici Format 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// Revision History: …
5
Comment documenter un projet déjà développé?
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 modifiées par les …
5
Gestionnaire de logiciels qui oblige les développeurs à faire de la gestion de projet
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 gestionnaire de logiciels, qui est mon …
4
Que comprend exactement la «documentation»?
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 lesquels il s'agit également d'une question …
5
Qu'est-ce que le «domaine problématique»
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 problématique?
5
Alternatif à l'aide HTML
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 avait …
En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.