Domande con tag 'documentation'

domande con tag
3
risposte

Come spiegare a un non programmatore di creare il codice sorgente di Visual Studio in modalità "Rilascio"?

Sto scrivendo documentazione per alcuni software che ho scritto. Nello specifico, sto scrivendo una guida per l'installazione del software. Sto consegnando il codice sorgente al mio cliente, quindi mi aspetto che vorranno essere in grado di comp...
posta 11.10.2013 - 22:44
4
risposte

La documentazione estesa è un codice olfattivo? [chiuso]

Ogni libreria, progetto open source e SDK / API che abbia mai incontrato è stata confezionata con un file di documentazione (di solito di grandi dimensioni) e questo sembra in contraddizione con l'opinione diffusa che un buon codice richiede poc...
posta 07.10.2012 - 04:49
2
risposte

Quali tipi di contenuti visivi, tabelle o diagrammi potrei voler includere nel Documento di architettura del progetto?

Oltre ai diagrammi di architettura logica e fisica, alle composizioni / mockup e alle tabelle per il carico di rete previsto tra componenti e vari schemi di dati, quali tipi di contenuti visivi, tabelle o diagrammi potrei voler includere nel Doc...
posta 19.08.2012 - 20:19
1
risposta

Come documentare le prove logiche contro le condizioni di gara?

Sfondo specifico Sto scrivendo una libreria per estendere la dorsale asincrona di una lingua con il multitasking cooperativo. (La lingua è Hack , ma C # implementa anche async-await con Task , se il concetto suona familiare.) Sono stato...
posta 05.03.2017 - 04:40
2
risposte

Sistema di controllo delle versioni locale appositamente progettato per i documenti

Devo lavorare su alcuni documenti, ho bisogno di un software in grado di tracciare tutte le modifiche che apporterò a uno specifico file o progetto (gruppo di file): c'è qualcosa del genere? L'importante è che devo farlo con una singola macch...
posta 24.11.2011 - 22:07
1
risposta

Cosa inserire in una documentazione di stored procedure?

Sono stato incaricato di documentare le nostre stored procedure. Pubblico di destinazione: tecnico Scopo: avere una buona documentazione in preparazione per la migrazione. Suppongo che qualcuno lo abbia già fatto.     
posta 04.09.2012 - 03:03
2
risposte

Quante informazioni deve contenere una docstring

Ho una funzione che accetta come argomenti un certo numero di classi di complessità media. Durante la scrittura di docstring per quella funzione, mi imbatto in una serie di domande: dovrei descrivere (oltre a ciò che sta facendo la funzione)...
posta 13.04.2018 - 11:31
2
risposte

Documentazione tecnica e documentazione di progettazione del software

Sto cercando di avviare una documentazione su una libreria di classi che è già stata completata / sviluppata. Lo scopo della documentazione deve essere utilizzato da altri sviluppatori per capire quale tipo di metodi sono inclusi in questa li...
posta 01.07.2018 - 21:45
5
risposte

Esegui su frasi nella scrittura tecnica

Questa è solo una domanda a cui pensare. Quando scrivi documentazione tecnica e commenti di programmazione, ti ritrovi mai a scrivere frasi run-on per essere più preciso? È meglio impacchettare più informazioni tecniche in una frase piutto...
posta 22.06.2011 - 22:22
2
risposte

Che cos'è il Context Diagram in uno SRS?

Sto imparando a scrivere una specifica dei requisiti di sistema e la maggior parte dei modelli che ho visto parlano di un diagramma di contesto. Che cos'è esattamente un diagramma di contesto?     
posta 18.01.2013 - 06:25