Si j'ai un morceau de code mathématiquement ou structurellement assez complexe et irréductible, comment pourrais-je documenter ce morceau de code? En particulier, comment puis-je m'assurer que quelqu'un qui ne possède pas les compétences mathématiques ou architecturales que je fais peut le...
Je cherchais (nonchalamment) des approches sémantiques / ontologiques de la documentation technique lorsque je suis tombé sur ce joyau : La programmation alphabétisée et le Web sémantique sont des idées d'époques différentes, qui ont un lien. L'article lié, Literate Programming in XML de Norman...
Premièrement, je me rends compte que cette question peut être quelque peu longue et vague et je m'en excuse. C'est probablement un problème de base avec un nom court pour quiconque "l'a compris", mais comme je me trouve à ce sujet manquant, je vous prie de bien vouloir me décrire le problème. Je...
Je voudrais voir comment les autres font ça. Surtout dans les situations où plusieurs clients différents utilisent la même base logicielle avec des règles métier légèrement différentes. Quel type de pratiques utilisez-vous pour documenter comment tout est censé fonctionner ou les règles métier....
Je suis sur le point de quitter un projet, et avant de partir, mon patron m'a demandé de documenter le code (je n'ai pas très bien documenté). Ce n'est pas grave, le projet n'est pas terriblement complexe. Mais je trouve des endroits dans ma documentation où je voudrais dire: "Remarquez en ligne...
Cela fait référence à une discussion dans une réponse et aux commentaires de cette question: Quelle est l'aversion pour la documentation dans l'industrie? . La réponse affirmait que «le code ne peut pas mentir» et devrait donc être l'emplacement de référence au lieu de la documentation. Plusieurs...
Lors de l'examen de l' implémentation d'une fonction par un autre programmeur pour calculer le CDF de distribution normale , j'ai suggéré de remplacer l'intégralité de l'implémentation par les fonctions intégrées de Python ou d'utiliser SciPy, une bibliothèque scientifique commune. Un autre...
Je travaille sur une petite bibliothèque qui fournit des implémentations de métriques de chaîne de base bien connues. Surtout pour ma propre éducation. Le développement se produit donc chaque fois que j'ai un peu de temps libre. Pour cette raison, j'ai automatisé la plupart des processus afin que...
Souvent, je me retrouve à résoudre des bugs en trouvant la réponse sur Stack Overflow. Est-ce une mauvaise pratique d'ajouter un extrait de la raison pour laquelle j'ai fait ce que j'ai fait, puis d'ajouter un lien vers un article ou une page sur le