Non chiunque abbia scritto la documentazione del software , ma tutti hanno letto la documentazione del software che ha lasciato molto a desiderare . Quando siamo alla ricerca per trovare informazioni su un pezzo di software , vogliamo sapere che cosa fa, quali sistemi operativi e altri programmi funziona con , come si può ottenere , e quanto costa . Cose che ti serviranno
Un pezzo di software
Mostra più istruzioni
Diversi tipi di software di documentazione
1
scrivere quello che fa il software . Dopo aver letto questo documento , il lettore dovrebbe essere in grado di determinare se necessita il software. Assicuratevi di includere tutte le funzionalità , che spesso può essere un elenco di tutte le funzionalità del software .
2
spiegare come le funzioni del software in relazione ad altri pezzi di software . Questo può parlare di altri pezzi di software che sono considerati competitors.Be sicuri di delineare ciò che questo software fa in modo diverso rispetto agli altri.
3
delineare i tipi di interfacce e di codice che sono utilizzati nel software . Questa sezione dovrebbe lasciare che il lettore di sapere che tipo di conoscenza che un utente dovrebbe avere per lavorare con questo software . Questa parte della documentazione del software viene utilizzato dai programmatori e altre persone tecniche .
4
Fare un documento per l' utente del software in modo che chi legge sarà in grado di iniziare a utilizzare il programma . Questi tipi di documenti possono essere tutorial . Possono anche essere liste di comandi o indici di dove gli utenti possono trovare le informazioni rilevanti .
5
documentazione scrivono che gli addetti alle vendite possono utilizzare quando stanno vendendo la software.Make assicurarsi di aver compreso tutte le capacità e punti di vendita del software .