Documenter une application d'accès pour les développeurs [fermé]

Question

Je dois documenter une application MS-Access qui a été créé, développé et maintenu entièrement par un utilisateur de puissance de plus de 10 ans.

Ceci est une situation intéressante parce que ce qu'ils veulent est un MANUALapparaît qu'un développeur futur peut venir sans connaissance de domaine avant et apporter des modifications au frontend ou backend en temps opportun.

Il y a quelques questions sur mon esprit pour ce petit projet:

• Quelle est une bonne application de création de conception manuelle? Microsoft Word ne coupe pas tout à fait.
• Quel genre de choses que vous, le développeur, besoin de connaître afin d'apporter des modifications à des choses comme des formulaires, des rapports, des tableaux ou d'autres objets d'accès?
• tout ce que je manqué? Tous les pièges?

Answer 1

Dans mon expérience, les programmes d'accès et VB6- sont en proie à la réplication plus de code et de la dette technique que les programmes dans les langues traditionnelles. Je ne sais pas pourquoi. Peut-être que c'est la nature de l'accès en tant que base de données « prototype » ou « jouet » (mais il peut être assez puissant quand donné correctement).

Si je devais choisir entre dépensant le temps sur la documentation et dépensant le temps sur la réduction de la dette technique, par exemple par remodularizing, en éliminant le code répété, le fractionnement des fonctions longues, etc., je choisirais celui-ci. L'amélioration de la maintenabilité et la lisibilité serait plus.

Answer 2

Vous pouvez commencer à générer une documentation de code automatique à l'aide MZ-outils add-in pour VBA. Le même complément aide peut vous nettoyer les déclarations de variables inutilisées, générer des numéros de ligne, Réorganiser les procédures dans un module, etc.

Documenter formes est plus difficile. Ma proposition serait de garder une capture d'écran, alltogether avec un fichier txt obtenu par la méthode application.saveAstext non documentée.

Answer 3

Je sais que c'est fermé depuis longtemps, mais je ne peux pas éviter d'ajouter mes 2 cents:
Dans le cas mentionné, je pense que le plus doc à produire est une très pratique, la documentation FONCTIONNEL (qui aurait dû exister avant de commencer le développement dans un monde idéal).
Deuxièmement, dans le code lui-même, et qui inclut la VBA, mais aussi les descriptions des champs qui peuvent être définis dans Access et SQL Server.
Le troisième est un (ou un ensemble de) schéma de base de données agréable. Une fois que vous avez cela, tout le reste peut être généré par le nouveau développeur en utilisant ses outils préférés.
En parlant des outils, je aime particulièrement et à recommander:

• MZ Outils: spécialement pour trouver facilement des routines qui appellent celui de votre recherche à
• Smart indent: le code correctement tiret. Essayer de lire le code mal indenté me rend malade
• SqlSpec: (pas libre) génère doc HTML de la base de données elle-même pour la plupart des moteurs de base de données

Answer 4

Avez-vous essayé l'utilisant la base de données intégrée Documenter? Il imprimera toutes les tables, index, formulaires, contrôles, chaque propriété des contrôles. Code, le sql utilisé et à peu près rien d'autre. Cela se traduit par d'énormes, mais juste des impressions massives. Cependant, alors qu'il va tuer quelques arbres dans le processus, il est sûr un excellent moyen d'impressionner le patron.