In sostanza , un rapporto software è una relazione tecnica che può includere un riepilogo settimanale , mensile o trimestrale di sviluppo o distribuzione del software . Può essere un rapporto di stato , bug report o rapporto di prova . Indipendentemente dalla natura esatta del rapporto , deve essere finalizzato alla destinatari nel tono e nella sostanza , essere ben scritto , , affrontare questioni concise ma dettagliate in modo chiaro , e offrono solutions.Things che ti serviranno

A capace programma di elaborazione testi , come ad esempio Microsoft Word

Tutti i dati e fatti rilevanti

Mostra Altre istruzioni

scrivere una relazione software

1 Iniziare il rapporto software con la formattazione prescritto .

Inizia il rapporto con software di formattazione prescritto . Comunemente , tale formattazione include frontespizio o una pagina memo e un elenco di figure , se si include tale . Le figure possono essere tabelle, grafici , schermate o altre immagini pertinenti al rapporto . Assicurati di identificarsi come lo scrittore , denominare il progetto , e includere la data avete preparato la relazione e lo stato del software o di progetto , se del caso .

2 Particolare l’emissione o questioni che riguardano il software .

Dettaglio il problema o problemi riguardanti il software . In un aggiornamento sullo sviluppo del software , i dettagli delle edizioni oi problemi che sono sorti e , se del caso , le soluzioni che sono state distribuite . In un rapporto di prova del software , inserire i risultati dei test e le azioni appropriate che vengono adottate per risolvere eventuali problemi individuati . Un bug report deve informare il programmatore o di altre informazioni appropriate Tecnologo l’esatta natura del problema , tra cui indicazioni precise su come trovare il problema .

3 Nella stesura del rapporto , essere specifico .

Nella stesura della relazione , essere specifico . Non dare per scontato che il lettore , indipendentemente da chi si rivolge a , saprà cosa fare . Fornire istruzioni passo passo , anche se sembrano semplicistica e inane . Potrebbe essere necessario elencare i passi , come ad esempio ” 1) Aprire tale – e – tale di un file” o ” 2) Premere Alt – L . ” Non ci sono scuse per trasformare in un rapporto sciatto o confusione .

4 Fornire dettaglio nel vostro rapporto .

Fornire dettaglio nel vostro rapporto . Anche in questo caso , non si assumono i vostri lettori sanno quello che sai . I dettagli sono fondamentali ed è di gran lunga meglio dire troppo che non abbastanza . Il lettore avrebbe preferito avere più informazioni rispetto finitura a leggere la relazione e domande senza risposta o, peggio , la lettura finale e di essere confuso .

5 Evitare lingua e le parole che non sono chiare .

Evitare il linguaggio e le parole che non sono chiare . Ad esempio , non usare “it” quando ci si riferisce al software specifico . Piuttosto che dire ” si apre una finestra di errore , ” dicono , “Software X apre una finestra di errore che …. ” e poi il messaggio di dettaglio della finestra di errore . Se c’è un problema con una particolare applicazione o funzione, descrivere in dettaglio con linguaggio preciso . Anche se si dispone di ripetere se stessi quando si descrive problemi o questioni , farlo per motivi di chiarezza .

6 Prima di inviare il report , leggere ad alta voce .

Prima di inviare il report , chiudere il vostro ufficio porta e lesse ad alta voce . Se ci sono errori o problemi grammaticali con la sintassi , si sente e li può correggere immediatamente . Come si esamina il report , assicurarsi di aver avuto precise e accurate e che tu hai descritto tutto in modo chiaro e conciso in modo che la vostra non sarà misconosciuto o frainteso .