Gestione della documentazione cartacea [chiuso]

Question

Dopo ogni nuovo programma scritto, rimane molta documentazione cartacea.

A parte le solite note scarabocchiate dei programmatori, di solito c'è un bel mucchio di documenti che contiene spiegazioni di modelli fisici, calcoli e così via (equazioni, tabelle, grafici, piccole immagini che descrivono le variabili ...)

Solitamente eseguiamo calcoli a elevata intensità numerica nelle applicazioni console, che non vengono rilasciate al pubblico (restano in casa, solo i risultati escono). Prima che ogni progetto sia finito, tutti quei documenti devono essere imballati in qualche modo con l'applicazione, in modo che un giorno, quando qualcuno ne riutilizzerà parti, abbia qualche idea di cosa ci sia dentro. Finora abbiamo usato la soluzione "sporca" per scansionare tutto e impacchettarlo sul disco con l'applicazione.

Quindi mi chiedevo ... per tutti i ragazzi della scienza qui in una situazione simile ... come gestite la documentazione di progetto che è necessaria, ma non rilasciata al pubblico? (quello che lo fa, va dai ladri dtp, e lo rendono bello e brillante - non è più il nostro problema :)

Answer 1

Uso una delle tre opzioni:

• Conserva tutto nei miei quaderni di laboratorio, da me archiviati, per contenuti di basso livello
• Scansiona il documento cartaceo e aggiungi al controllo del codice sorgente in pdf. È brutto, ma se qualcuno ne ha bisogno, è lì
• Trascrivi le equazioni, i risultati, ecc ... in un formato pulito (solitamente Latex) per riferimento futuro e, di nuovo, aggiungi al controllo del codice sorgente. La copia cartacea ufficiale viene firmata (lavoro in un dominio altamente regolamentato) e archiviata in un raccoglitore.

Answer 2

Nei progetti a cui ho lavorato abbiamo fatto molti calcoli di fisica nei nostri programmi e di conseguenza abbiamo molte sessioni di lavagna con equazioni su cui stiamo lavorando.

Manteniamo una wiki per ogni grande progetto e dopo ogni sessione di lavagna fotografiamo fisicamente la lavagna con una fotocamera digitale e la cariciamo / organizziamo all'interno della wiki. Scansioniamo anche documenti cartacei dai quaderni degli sviluppatori se è importante e li includiamo anche nel wiki.

Quindi, eseguiamo il backup del wiki su disco per l'archiviazione. Quindi la nostra soluzione è abbastanza simile alla tua, oltre a usare il wiki del progetto per l'organizzazione.

Answer 3

Se è importante, mi sembra che dovresti trattare la documentazione interna con la stessa cura con cui tratti i documenti pubblici.

Answer 4

Creo prototipi di carta UI durante la progettazione dell'interfaccia utente di un'applicazione, che produce un sacco di carte di formato A3 (in un progetto avevamo molti banchi coperti di carta). Quando il design è pronto o deve essere inviato a qualcuno, lo scatto con una fotocamera digitale, in modo da poter produrre una serie di immagini che mostrano come eseguire alcune attività sull'interfaccia utente, che funge da documentazione di come il l'applicazione è pensata per funzionare. Questo serve anche come backup, nel caso in cui qualcuno rubi / ripulisca i documenti originali.

Answer 5

Ecco alcuni dei pensieri ... Anche se non così pratici :)

1. Possiamo renderlo parte delle nostre note relative al Check-in. Questo può aiutare gli sviluppatori a mantenere l'applicazione.
2. Aggiorna il documento dei requisiti / Documento di progettazione di basso livello con questi elementi