Non tutti ha scritto documentazione del software, ma tutti hanno letto la documentazione del software che ha lasciato un po 'a desiderare. Quando stiamo cercando di trovare informazioni su un pezzo di software, vogliamo sapere che cosa fa, che cosa operativi sistemi e altri programmi con cui lavora, come possiamo farlo, e quanto costa.

istruzione

Diversi tipi di documentazione del software

1 Scrivi ciò che il software fa. Dopo aver letto questo documento, il lettore dovrebbe essere in grado di determinare se ha bisogno del software. Assicurati 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ò citare altri pezzi di software che sono considerate concorrenti.
Assicurati di delineare ciò che questo pezzo di software fa in modo diverso rispetto agli altri.

3 Delineare i tipi di interfacce e codice utilizzati nel software. Questa sezione dovrebbe lasciare che il lettore di sapere che tipo di conoscenza che un utente dovrebbe avere a lavorare con questo pezzo di software. Questa parte della documentazione del software è usato da programmatori e gli altri tecnici.

4 Fare un documento per l'utente del software in modo che chi lo legge sarà in grado di iniziare a utilizzare il programma. Questi tipi di documenti possono essere esercitazioni. Possono anche essere liste di comandi o indici di dove gli utenti possono trovare le informazioni rilevanti.

5 Scrivere la documentazione che le persone di vendita possono utilizzare quando stanno vendendo il software.
Assicurarsi di aver compreso tutte le funzionalità e dei punti di vendita del software.

Consigli e avvertenze

• Non abbiate paura di consultare esperti in materia sul software. Il più delle volte essi saranno lieti di aiutare a meglio la documentazione del software.