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.

6
«Je», «Nous» ou Ni dans la documentation du code
Je me retrouve à écrire (espérons-le) des commentaires utiles dans la documentation de code (C ++) du type: The reason we are doing this is... La raison pour laquelle j'utilise "nous" au lieu de "je", c'est parce que je rédige beaucoup d'écrits académiques où "nous" est souvent préféré. Alors voici …
6
Format tableur convivial pour Git? [fermé]
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 convertir, par exemple, en multimarkdown avec une option pour …
9
Les non-informaticiens peuvent-ils gérer un wiki? [fermé]
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 perspectives" "qui …
3
Quels sont les obstacles auxquels se heurte le processus de développement en utilisant des langages de balisage en texte brut, par exemple, Microsoft Word? [fermé]
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é à collaborer sur une base …
3
Origine du «Readme»
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 document?
2
Comment faire de la documentation pour le code et pourquoi les logiciels sont-ils (souvent) mal documentés?
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 à …
5
Concevoir des documents dans le cadre d'Agile
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 que nous générions …
4
BDD est-il réellement accessible en écriture par des non-programmeurs?
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 le script de définition de fonctionnalité …
7
Libérer d'abord ou documenter d'abord?
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 …
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.