Domande taggate «documentation»

La documentazione del software è un testo scritto che accompagna il software del computer. Spiega come funziona il software, come installarlo, come usarlo e altre risorse di aiuto.

7
Un documento di design dovrebbe contenere una discussione dei pro / contro di un determinato design o dovrebbe concentrarsi su fatti e motivazioni?
Attualmente sto aggiornando un documento di progettazione in modo che sia corretto e aggiornato per i futuri sviluppatori. Attualmente, il documento si concentra solo sui fatti, presentando come è il design. Non vi è alcuna motivazione per le decisioni presentate. Credo che sia importante catturare la logica in modo che …
7
Cosa devo includere nell'intestazione della documentazione della mia classe
Sto cercando un formato di documentazione informativo per le classi Entity, Business Logic e Data Access. Ho trovato i seguenti due formati da qui Formato 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// Revision History: /// …
3
Come si leggono gli RFC e documenti simili? [chiuso]
Chiuso . Questa domanda richiede dettagli o chiarezza . Al momento non accetta risposte. Vuoi migliorare questa domanda? Aggiungi dettagli e chiarisci il problema modificando questo post . Chiuso 4 anni fa . RFC : Request for Comments (RFC) è un memorandum pubblicato dall'Internet Engineering Task Force (IETF) che descrive …
7
Documentazione degradante: come gestirla?
Importante : non abbiamo alcun problema con la documentazione del codice sorgente . Questo appartiene al controllo periodico del codice ed è tenuto aggiornato. Il nostro problema è con la documentazione per gli sviluppatori (o, se preferisci, "esterna"), piccoli consigli da programmatore a programmatori che tendono ad essere scritti una …
4
Cosa comprende esattamente la "documentazione"?
Quando diciamo "documentazione" per un prodotto software, cosa include e cosa non dovrebbe includere? Ad esempio, una domanda recente ha chiesto se i commenti sono considerati documentazione? Ma ci sono molte altre aree per cui questa è una domanda valida, alcune più ovvie di altre: Manuali (ovviamente) Note di rilascio? …
5
Che cos'è "Dominio problematico"
Devo documentare il mio programma per un progetto scolastico e abbiamo una sezione chiamata "dominio problematico" ma non ho idea di cosa discutere in questa sezione. Quindi la domanda è: cosa dovrebbe essere discusso nel dominio del problema?
5
Si alterna alla Guida HTML
Attualmente utilizziamo un sistema chiamato AsciiDoc che ci consente di creare documentazione in un semplice markup di testo. Da ciò possiamo generare più formati di output. Utilizziamo solo i formati di output pdf e chm. Mi chiedevo se ci fosse un'alternativa a chm? Quello che sto cercando è qualcosa che …
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.