Manipulation de la documentation papier [fermé]

Question

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

Hormis les notes de gribouillis habituelles des programmeurs, il existe généralement un tas de documents contenant des explications de modèles physiques, des calculs, etc. (équations, tableaux, graphiques, petites images décrivant des variables, etc.)

Nous effectuons généralement des calculs à forte intensité numérique dans les applications console, qui ne sont pas rendues publiques (restez dans la maison, seuls les résultats sortent). Avant que chaque projet ne soit terminé, tous les documents doivent être emballés avec l'application, de sorte qu'un jour, lorsque quelqu'un en réutilisera une partie, aura une idée de ce qui est à l'intérieur. Jusqu'à présent, nous avons eu recours à la solution "sale" qui consiste à tout balayer et à enregistrer sur le disque avec l'application.

Je me demandais donc ... pour tous les scientifiques de la même situation dans une situation similaire ... comment gérez-vous la documentation de projet nécessaire, mais non rendue publique? (Celui qui le fait va aux dtp laddies, et ils le rendent beau et brillant - ce n’est plus notre problème:)

Answer 1

J'utilise l'une des trois options suivantes:

• Conservez tout dans mes cahiers de laboratoire, que je m'archive moi-même, pour les éléments de bas niveau
• Numérisez le document papier et ajoutez-le au contrôle de source en pdf. C'est moche, mais si quelqu'un en a besoin, c'est là
• Transcrivez les équations, les résultats, etc ... dans un format épuré (généralement le type Latex) pour référence future, puis ajoutez-les au contrôle de source. La copie papier officielle est signée (je travaille dans un domaine très réglementé) et classée dans un classeur.

Answer 2

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

Nous conservons 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 / organisons dans le wiki. Nous numérisons également dans les documents papier des cahiers de développeurs si cela est important et les incluons également dans le wiki.

Ensuite, nous sauvegardons le wiki sur disque pour le stockage. Notre solution est donc assez similaire à la vôtre, à part que nous utilisons le wiki du projet pour l’organisation.

Answer 3

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

Answer 4

Je crée des prototypes de papier d'interface utilisateur lors de la conception de l'interface utilisateur d'une application produisant de nombreux papiers de format A3 (dans un projet, plusieurs bureaux étaient recouverts de papier). Lorsque le dessin est prêt ou qu'il doit être envoyé à quelqu'un, je le prends en photo avec un appareil photo numérique afin de pouvoir produire une série de photos montrant comment effectuer certaines tâches sur l'interface utilisateur, ce qui sert à documenter la l'application est censée fonctionner. Cela sert également de sauvegarde, au cas où quelqu'un vole / nettoie les papiers d'origine.

Answer 5

Voici certaines des pensées ... Pas si pratiques cependant:)

1. Nous pouvons l'intégrer à nos notes d'enregistrement. Cela peut aider les développeurs à maintenir l'application.
2. Mettez à jour le document d'exigence / le document de conception de niveau inférieur avec ces éléments