Domanda:
Devo archiviare le mie liste di controllo come documentazione?
Rarity
2012-04-13 21:04:52 UTC
view on stackexchange narkive permalink

Conservo molte piccole liste di cose da fare. Li tenevo su un taccuino legale e ho buttato via le pagine quando avevano finito. Ora uso un'app per iPad, quindi la mia cronologia è sempre memorizzata, ma non la salvo in alcuna forma di documentazione ufficiale.

Sono un programmatore, quindi la maggior parte del mio lavoro è documentato tramite il controllo della versione , ma ci sono molte piccole correzioni al software non controllato dalla versione, alle modifiche al database e ai controlli che eseguo mentre ricopro anche una sorta di ruolo di supporto.

Abbiamo cercato di documentare quello che facciamo nel mio reparto più che l'idea mi è venuta, ma le mie modifiche non sono quelle che hanno causato problemi.

Devo mantenere la mia lista delle attività come una sorta di documentazione ufficiale? Come posso assicurarmi che sia effettivamente utile per qualcuno diverso da me?

Perché le modifiche al database non dovrebbero essere nel controllo del codice sorgente? E perché non controllare gli script che usi per fare i controlli?
@HLGEM Sto lavorando per iniziare, ma non si tratta solo di cose di database
Sette risposte:
#1
+8
Tech Lover in NYC
2012-04-14 09:00:07 UTC
view on stackexchange narkive permalink

Sembra che il tuo dipartimento stia cercando di tenere traccia di chi sta facendo cosa e cosa viene fatto, quindi a tal fine direi di sì, dovresti tenerli. Detto questo, sembra che nel formato in cui sono, non saranno utili a molte altre persone, poiché potrebbero essere raccolte casuali di attività grandi e piccole con poche informazioni o tag associati.

Se ci sono è uno sforzo concertato nel tuo dipartimento per tracciare e documentare di più, sembra un buon momento per iniziare a utilizzare il software per questo. Uno degli enormi vantaggi dell'utilizzo di un servizio come Fogbugz, Teambox, Trello, Pivotal Tracker, ecc., È che tutto ciò che fai diventa ricercabile sia per te che per i membri del team attuali o futuri. Vuoi vedere la prima volta che qualcuno ha affrontato un problema particolare o se si presenta spesso? Cercalo e guarda cosa viene fuori.

Personalmente, ho implementato Teambox nel mio posto di lavoro e incoraggio i miei colleghi a usarlo per attività di collaborazione. Ma lo uso anche io stesso per cose di cui solo io ho bisogno di tenere traccia, sapendo che chiunque sia nel mio ruolo in futuro (anche se sono io!) Può apprezzare questa storia di come certe cose venivano gestite prima.

Molti di questi sistemi sono abbastanza veloci e facili da usare e integrano un flusso di commenti per fare in modo che gli aggiornamenti e le discussioni su un'attività vengano memorizzati con quell'attività. Inoltre, se sono presenti elenchi di attività ripetibili, molti di questi sistemi consentono di memorizzarli come modello.

Usa un sistema di ticketing (chiamato anche Issue Tracking: come Trello, Jira ... ecc.).
#2
+6
Brandon
2012-04-13 21:59:26 UTC
view on stackexchange narkive permalink

Ho avuto la stessa situazione nel mio precedente datore di lavoro. Ho finito per iniziare a scrivere nel nostro wiki ogni volta che avevo un nuovo problema di supporto non banale che dovevo affrontare. È stato un po 'illuminante, poiché c'era una quantità significativa di informazioni che avevo appena interiorizzato. Anche le piccole questioni presumono davvero che tu abbia almeno un certo livello di conoscenza istituzionale.

È una seccatura da fare quando inizi, ma dopo, è piuttosto carino perché puoi prenderti una vacanza e magari prendere un telefono chiama invece di 3-4 al giorno. :)

Sembra molto più di una semplice lista di controllo.
Vorrei che avessimo un Wiki, mi piaceva l'idea di un wiki in un sistema di ticketing. Tutto quello che abbiamo sono documenti word orribilmente ordinati
@FrustratedWithFormsDesigner Sì, le mie cose quotidiane potrebbero essere una lista di controllo per me, ma non lo sarà per qualcun altro. Probabilmente avranno bisogno della mezza pagina di informazioni di base per capire cosa sta succedendo.
@Rarity Creane uno. Installa IIS sul server di sviluppo, prendi Windows Platform Installer e installa ScrewTurn ed esegui semplicemente con esso. Preferisco chiedere perdono piuttosto che il permesso. :)
@Brandon Ci ho trasferito da Apache per portarci LONTANO da Windows Platform Installer! Cercare di usare PHP da quella cosa è stato un incubo ...
@Rarity Io stesso sono un ragazzo di Windows .NET, quindi ho utilizzato per impostazione predefinita WPI, ma capisco da dove vieni. Lancia MediaWiki in una scatola di Apache e vai in città. :)
#3
+3
voretaq7
2012-04-13 23:09:05 UTC
view on stackexchange narkive permalink

Direi che dovresti documentare tutto ciò che fai. Se l'unica documentazione è la lista di controllo, allora sì, dovrebbe essere salvata in qualche modo.

Una nota sulla terminologia, però, non sto parlando di "documentazione" nel senso che qualcun altro vi farà riferimento in seguito, io sto parlando di un record delle tue attività, adatto per essere menzionato nella tua revisione delle prestazioni. Tenere un elenco di ciò che hai fatto ti aiuterà a mettere insieme una dichiarazione di risultati e, se hai mancato obiettivi importanti, ti darà un'idea di quali altri compiti sono emersi che hanno fatto slittare gli obiettivi / le scadenze.

#4
+2
FrustratedWithFormsDesigner
2012-04-13 21:21:46 UTC
view on stackexchange narkive permalink

Forse. Penso che il luogo in cui sarebbero più utili sarebbe addestrare il personale ad assumere nuovi compiti con cui non hanno familiarità. Ad esempio, la risoluzione dei problemi di una classe specifica di problemi potrebbe comportare l'esecuzione di alcuni passaggi e l'utilizzo di un elenco di controllo per eliminare determinate situazioni. Un elenco di controllo potrebbe anche essere utile per attività come distribuzioni di codice complicate o modifiche al server. Ho visto semplici elenchi di controllo nella documentazione delle guide alla configurazione per sviluppatori per la configurazione dell'ambiente per progetti più complessi.

Lo svantaggio di un elenco di controllo è quando la persona che lo segue si trova inconsapevolmente su un'istanza dell'attività che si discosta un po 'da ciò che la lista di controllo assume Si spera, però, che ciò non accadrà fino a quando la persona non sarà abbastanza esperta da non aver bisogno della lista di controllo e prendere le proprie decisioni.

Si vuole anche evitare che le persone diventino completamente dipendenti dalla lista di controllo, quindi forse non non renderlo troppo dettagliato - magari scriverlo più come una linea guida di alto livello, a meno che l'attività specifica non cambierà e il dettaglio profondo non sia necessario.

Purtroppo le mie liste di controllo sono più solo per me, ci vorrebbe qualche sostanziale riscrittura perché siano utili agli altri. soprattutto perché qualcosa di più di "quello che ho fatto ultimamente"
@Rarity: Sono almeno ripetibili, in modo tale da poterli riutilizzare in futuro per evitare di dover ricostruire tutto da capo?
Non ancora, di solito non sono suddivisi in sotto-attività. Se qualcosa è effettivamente complicato, lo metto in un documento vero e proprio, come come installare il nostro server.
@Rarity: Utile solo per te, per attività non ripetibili ... In base a come le descrivi, penso che potresti ottenere più utilità archiviando le tue liste della spesa come documentazione. Almeno quelli sono * a volte * ripetibili. ;)
#5
+1
IDrinkandIKnowThings
2012-04-13 23:50:23 UTC
view on stackexchange narkive permalink

Dovresti controllare la politica di conservazione dei documenti della tua azienda. Alcune aziende potrebbero richiederti di mantenerle, altre no. Il motivo è che dopo un certo periodo di tempo possono essere considerati documenti rilevabili per procedimenti legali. Questi variano a seconda della compagnia. Ho lavorato presso aziende che hanno considerato qualsiasi documento per 5 anni un record che richiedeva conservazione. Anche se si trattava di un menu utilizzato per il cibo da asporto su cui non era stato scritto alcun segno.

Da Wikipedia

Il periodo di conservazione di un documento è un aspetto della gestione dei record. Rappresenta il periodo di tempo in cui un documento deve essere conservato o "conservato" sia elettronicamente che in formato cartaceo. Al termine del periodo di conservazione, il documento viene solitamente distrutto. Il termine è generalmente utilizzato da contabili e professionisti fiscali la cui occupazione comporta il trattamento di documenti legali che devono rimanere in vigore solo per un certo periodo di tempo. Il periodo di conservazione varia a seconda dei diversi tipi di record. Ad esempio, i documenti per la costituzione di una società hanno un periodo di conservazione permanente (nel senso che dovrebbero essere conservati e non essere mai distrutti), ma le ricevute per acquisti deducibili dalle tasse da parte di un singolo contribuente di solito hanno un periodo di conservazione di tre anni (e spesso possono essere scartate in sicurezza dopo quel punto.) La durata del periodo di conservazione varia a seconda del settore e si basa sulla probabilità che il documento sarà necessario in futuro per motivi di legatoria. I record che non servono a più scopi (come determinato dalla durata del loro periodo di conservazione) vengono distrutti per problemi di spazio, di solito dai distruggidocumenti.

#6
+1
Reinstate Monica - Goodbye SE
2012-04-14 16:48:30 UTC
view on stackexchange narkive permalink

Per rispondere prima alla tua ultima domanda, saprai solo se altre persone sono interessate dopo averlo documentato da qualche parte altri possono vederlo.

Il mio suggerimento: documentalo su un wiki dove tutti possono vederlo. Puoi metterlo su una pagina come procedura "ufficiale" per la tua posizione o su una pagina personale. Ma almeno le altre persone possono vederlo quando sei lontano e assumersi i tuoi compiti. E le persone che occupano posizioni simili in tutta l'azienda possono rivedere e scambiare idee.

La chiave è mantenerlo pubblico e facile da aggiornare (e accedere, anche tramite il tuo iPad).

#7
  0
JohnFx
2012-04-13 23:38:37 UTC
view on stackexchange narkive permalink

Hai un sistema di monitoraggio dei casi come Bugzilla o FogBugz? Lavoro in un team di programmazione e usiamo le nostre istanze FogBugz per attività generali oltre a bug / richieste di funzionalità e funziona abbastanza bene.

È un sistema piccolo e praticamente un team di un solo uomo per qualsiasi correzione, quindi non usiamo un bug tracker, ma solo inviare messaggi. Non è stato un problema abbastanza grande da convincere qualcun altro a utilizzare un bug tracker.
In realtà potresti essere fortunato allora. FogBugz (e probabilmente altri) ti consentirà di utilizzare gratuitamente la versione ospitata del loro strumento se hai meno di 2 utenti (http://www.fogcreek.com/fogbugz/StudentAndStartup.html)


Questa domanda e risposta è stata tradotta automaticamente dalla lingua inglese. Il contenuto originale è disponibile su stackexchange, che ringraziamo per la licenza cc by-sa 3.0 con cui è distribuito.
Loading...