Handhabung von Papierdokumentation [geschlossen]

Question

Nach jedem neuen Programm eine Menge Papier Dokumentation geschrieben bleibt.

Neben den üblichen kritzeln Notizen von den Programmierern gibt es in der Regel ein schöner Haufen von Papieren enthalten, physikalische Modell Erklärungen, Berechnungen usw. (Gleichungen, Tabellen, Grafiken, kleine Bilder zu beschreiben Variablen ...)

Wir machen in der Regel numerisch intensive Berechnungen in Konsolenanwendungen, die für die Öffentlichkeit freigegeben werden, nicht (bleiben im Haus, führt nur ausgehen). Vor jedem Projekt all diese Papiere abgeschlossen haben irgendwie mit der Anwendung verpackt werden, so dass ein Tag, wenn jemand Teile davon werden wiederverwendet, eine Vorstellung hat, was, was da drin ist. Bisher haben wir schon die ganze es die ‚schmutzige‘ Lösung mit nur Scannen und es bis auf der Scheibe mit der Anwendung Verpackung.

So habe ich mich gefragt ... für alle Wissenschaft Jungs hier in einer ähnlichen Situation ... wie gehen Sie mit der Projektdokumentation, die notwendig ist, aber nicht für die Öffentlichkeit freigegeben? (Derjenige, der Fall ist, geht an die dtp laddies, und sie machen es schön und glänzend - nicht unser Problem mehr:)

Answer 1

Ich verwende eine von drei Optionen:

• Halten Sie alles in meinem Labor Notebooks, die ich selbst archivieren, für Low-Level-Sachen
• Scannen Sie das Papierdokument, und fügen Sie Steuerung im PDF beziehen. Es ist hässlich, aber wenn jemand es braucht, es ist da
• Transkribieren der Gleichungen, Ergebnisse, etc ... in einem sauberen Format (in der Regel Latex) für die Zukunft, und wieder zur Quellcodeverwaltung hinzufügen. Offizielle Papierkopie unterzeichnet wird (ich in einer stark regulierten Domäne arbeiten) und in einem Bindemittel eingereicht.

Answer 2

In den Projekten, die ich gearbeitet habe wir eine Menge Physik-Berechnungen in unseren Programmen getan haben, und folglich haben wir eine Menge von Whiteboard-Sitzungen mit Gleichungen arbeiten wir an.

Wir halten ein Wiki für jedes größeres Projekt und nach jeder Whiteboard Sitzung, die wir fotografieren physisch das Whiteboard mit einer Digitalkamera und laden / organisieren es im Wiki. Wir scannen auch in Papierdokumenten von den Entwicklern Notebooks, wenn es wichtig ist, und es in dem Wiki auch.

Dann können wir wieder auf das Wiki auf der Disc für die Lagerung. So ist unsere Lösung ist ziemlich ähnlich wie bei Ihnen, anders als wir das Projekt Wiki für die Organisation verwendet werden.

Answer 3

Wenn es wichtig ist, scheint es mir, sollten Sie die interne Dokumentation mit der gleichen Sorgfalt behandeln, mit dem Sie die öffentlichen Dokumente behandeln.

Answer 4

I UI Papier-Prototypen zu erstellen, wenn die Benutzeroberfläche einer Anwendung entwerfen, die eine Menge der Größe A3 Papiere produzieren (in einem Projekt, das wir hatten viele Tische abgedeckt mit Papieren). Wenn das Design fertig ist oder muss es jemand geschickt werden, nehme ich Bilder davon mit einer Digitalkamera, so dass ich eine Reihe von Bildern erzeugen kann zeigen, wie einige Aufgaben auf der Benutzeroberfläche auszuführen, die als Dokumentation, wie das dient Anwendung arbeiten soll. Dies dient auch als Backup, falls jemand stiehlt / reinigt die ursprünglichen Papiere weg.

Answer 5

Hier sind einige der Gedanken ... Nicht so praktisch aber:)

1. Wir können es Teil unserer Check-in Notizen machen. Dies kann den Entwickler helfen, die Anwendung gehen zu halten.
2. Aktualisieren Sie die Anforderung Dokument / Low-Level-Design-Dokument mit diesen Produkten