Manipulation de la documentation sur le papier

Question

Après chaque nouveau programme, il reste beaucoup de documentation papier.

En dehors des habituelles il y a généralement des notes des programmeurs griffonner un tas de papiers belle contenant des explications modèles physiques, calculs et ainsi de suite (équations, tableaux, graphiques, petites images décrivant les variables ...)

Nous généralement faire des calculs numériquement intensifs dans les applications de la console, qui ne sont pas diffusées au public (rester dans la maison, seuls les résultats sortent). Avant que chaque projet soit terminé, tous ces documents doivent être emballés en quelque sorte avec l'application, de sorte qu'un jour, quand quelqu'un va en réutiliser des parties, a une idée de ce qui est là. Jusqu'ici, nous avons utilisé la solution 'sale' consistant simplement à tout numériser et à l'emballer sur le disque avec l'application.

Donc je me demandais ... pour tous les scientifiques ici dans une situation similaire ... comment gérez-vous la documentation du projet qui est nécessaire, mais pas publié au public? (celui qui fait, va aux laddies pao, et ils font belle et brillante - pas notre problème plus :)

Answer 1

J'utilise une des trois options:

• Gardez tout dans mes cahiers de laboratoire, que je me archiver, pour des trucs bas niveau
• Scannez le document papier, et ajouter au contrôle de source en format pdf. C'est moche, mais si quelqu'un en a besoin, c'est là
• Transcrivez les équations, les résultats, etc ... dans un format propre (habituellement Latex) pour référence future, et encore, ajoutez au contrôle de la source.La copie papier officielle est signée (je travaille dans un domaine hautement réglementé) et classée dans un classeur.

Answer 2

Voici quelques-unes des pensées ... Pas si pratique que :)

1. Nous pouvons le faire partie de nos notes d'enregistrement. Cela peut aider les développeurs à maintenir l'application.
2. Mise à jour du document exigence/bas document de conception de niveau avec ces éléments

Answer 3

Dans les projets que j'ai travaillé que nous avons fait beaucoup de calculs de physique dans nos programmes et nous avons par conséquent beaucoup de sessions tableau blanc avec équations sur lesquelles nous travaillons.

Nous gardons un wiki pour chaque projet majeur et après chaque session de tableau blanc, nous photographions physiquement le tableau blanc avec un appareil photo numérique et le téléchargeons/l'organisons dans le wiki. Nous scannons aussi les documents papier des cahiers des développeurs si c'est important et les incluons aussi dans le wiki. Puis, nous sauvegardons le wiki sur le disque pour le stockage. Donc, notre solution est assez similaire à la vôtre, sauf que nous utilisons le wiki du projet pour l'organisation.

Answer 4

Si c'est important, il me semble que vous devriez traiter la documentation interne avec le même soin avec lequel vous traitez les documents publics.

Answer 5

Je crée des prototypes de papier UI en concevant l'interface utilisateur d'une application, qui produit beaucoup de papiers de format A3 (dans un projet, nous avions beaucoup de bureaux couverts de papiers). Lorsque le design est prêt ou qu'il doit être envoyé à quelqu'un, je prends des photos avec un appareil photo numérique, de sorte que je puisse produire une série d'images montrant comment effectuer certaines tâches sur l'interface utilisateur, qui sert de documentation de la façon dont l'application est destinée à fonctionner. Cela sert également de sauvegarde, au cas où quelqu'un vole/nettoie les papiers d'origine.