Duplication de maintenance - code et documentation

Question

Ce n'est peut-être pas le meilleur titre - j'apprécierais que quelqu'un en trouve un meilleur après avoir lu mon problème. De plus, je tiens à dire d'emblée que je suis en grande partie autodidacte sur Internet, donc il y a peut-être beaucoup d'outils que je ne connais pas. Je suis en train de maintenir un logiciel implémentant le concept de programmation basée sur le débit (FBP) en Java et en C#. Pour chacun d'eux, je code sur:

• mon site
• SourceForge système de sortie de fichiers (fichiers zip ou fichiers jar)
• SourceForge SVN

En outre, j'avoir des références de version et les descriptions (parfois partielles) sur:

• mon site web (HTML)
• mon wiki
• Javadoc

Il y a aussi un outil de dessin, également sur mon site et SourceForge, qui doit connaître la dernière version de la version Java du code FBP.

Tout est très bien relié, mais parfois une référence me manque! Il y a quelques jours, je me suis aperçu que je ne l'avais pas mis à jour SourceForge Nouvelles pour mon projet depuis longtemps, donc je devais faire tohu-:-)

Je me rends compte que certains de ces véhicules sont probablement redondants, mais en général, je ne sais pas qui regarde quoi. Donc, ma question est de savoir s'il existe un moyen de réduire tous ces frais généraux, par exemple, par exemple. une fonction HTML "imbed" serait bien, donc je peux au moins stocker le dernier numéro de version en un seul endroit. Je peux probablement simplifier les références croisées Java, mais l'inter-langage serait encore plus agréable, mais improbable, je suppose.

Toutes les idées seraient les bienvenues.

Answer 1

Il me semble que vous voulez mettre à jour et maintenir votre documentation dans le cadre de votre processus de génération/déploiement, par exemple.

1. build
2. Unité de test etc
3. la documentation
compilation
4. Deploy construit
5. Déployez documentation compilée

sinon vous êtes toujours va être votre queue chasser. De toute évidence, le déploiement de la documentation nécessitera des solutions différentes (par exemple, copié sur votre site Web, envoyé par FTP, etc.)

Je ne suis pas sûr qu'il existe une panacée pour tout cela. Je gère les numéros de version dans les fichiers de propriétés/fichiers de configuration, et effectue les recherches/remplacements appropriés. La documentation du code, dans la mesure du possible, va dans le code lui-même, puis elle est prétraite dans ma construction (étape 3 ci-dessus).Avez-vous vu/utilisé Doxygen? Cela répond à vos besoins multilingues et est bien établi pour la création/la maintenance de la documentation.

Answer 2

Il semble que vous ayez besoin d'automatiser votre processus de construction/publication. J'ai lu this article sur O'Reilly un certain temps - il semble que vous avez tous les deux des situations assez similaires? Sa solution fait un usage intensif de Python, mais à tout le moins, cela pourrait vous donner quelques idées.