Domande con tag 'documentation'

domande con tag
3
risposte

Nome della finestra di avvio / caricamento iniziale del programma?

Sto scrivendo la documentazione per l'utente (un SOP) che riguarda programmi di terze parti che sto cercando di descrivere bene. Uno di questi è un server che offre poche indicazioni sulla sua messa in servizio oltre a un grafico che mostra dura...
posta 09.08.2016 - 19:01
12
risposte

Esiste un motivo logico per generare automaticamente la documentazione del codice? [chiuso]

La generazione automatica della documentazione può essere eseguita con una varietà di strumenti, GhostDoc è uno dei più importanti. Tuttavia, per definizione, tutto ciò che genera è ridondante. Dà un'occhiata ai nomi di metodi, classi, ecc. E pr...
posta 08.09.2014 - 17:08
17
risposte

Come trattare la tautologia nei commenti? [chiuso]

A volte mi trovo in situazioni in cui la parte del codice che sto scrivendo è (o sembra essere ) così evidente che il suo nome sarebbe sostanzialmente ripetuto come commento: class Example { /// <summary> /// The location of the...
posta 29.03.2012 - 10:26
20
risposte

Dovresti scrivere una buona documentazione e pulire il codice per aumentare il "Bus Factor"?

Uno degli obiettivi principali delle società di sviluppo software è aumentare il fattore Bus . Questo è anche sostenuto in un conversazione organizzata da Google . Questo significa che dovresti codificare e documentare tutto in un modo che...
posta 04.10.2011 - 16:07
14
risposte

Cos'è l'avversione alla documentazione del settore?

Sembra esserci un'avversione per scrivere anche la documentazione più elementare. I nostri README di progetto sono relativamente semplici. Non ci sono nemmeno elenchi aggiornati di dipendenze nei documenti. C'è qualcosa di cui non sono a cono...
posta 20.06.2013 - 19:21
7
risposte

Come tieni traccia di quali classi e funzioni ha scritto il tuo team?

Quando si lavora sul codice, affronterò molte delle stesse sfide che i miei compagni di squadra fanno, e ho scritto alcune funzioni e classi utili, e così anche loro. Se c'è una buona comunicazione, sentirò parlare di una cosa grandiosa che qual...
posta 30.04.2013 - 16:37
6
risposte

"I", "Noi" o Nulla nella documentazione del codice

Mi trovo a scrivere (si spera) commenti utili nella documentazione del codice (C ++) del tipo: The reason we are doing this is... La ragione per cui utilizzo "noi" invece di "io" è perché faccio un sacco di scrittura accademica in cui "noi"...
posta 15.03.2013 - 19:42
6
risposte

Cosa devo fare per lasciare un lavoro professionalmente? [duplicare]

Dato che l'attuale datore di lavoro conosce e ha ricevuto un preavviso in anticipo, come può un programmatore effettuare una transizione di lavoro pulita dal suo vecchio lavoro? Quali cose dovrebbe prendere in considerazione il programmatore?...
posta 01.06.2011 - 18:52
9
risposte

Le persone non IT possono gestire un wiki? [chiuso]

La mia azienda sta cercando di migliorare la gestione dei dati di ricerca di mercato. Stile di gestione dei dati corrente: "Ehi Jimbo, dov'è l'immagine del nostro WhatZit 2.0? "sì, mi ricordo quell'email di quella società da quel raga...
posta 20.06.2011 - 13:33
6
risposte

Metodologia per documentare la base di codice esistente

Lavoro come parte di un team su un'applicazione esistente che non ha documentazione in linea e non ha documentazione tecnica. Come ho lavorato su vari bug report sull'applicazione, ho scritto una sorta di traccia di breadcrumb per me stesso - nu...
posta 18.11.2008 - 19:02