Kako napisati Readme

Sadržaj

Koraci
Savjeti
Što trebaš

Readme datoteka je mali dokument koji je obično uključen u program. Datoteke Readme napisali su programeri softvera i sadrže osnovne podatke o programu, uključujući informacije o instalaciji ili vodič za postavke sustava, podatke za kontakt, licencu, pohvale i podatke o verziji softvera. Za distribuciju softvera važno je znati napisati datoteku Readme. Loše napisan Readme može biti frustrirajući i dosadan za korisnika, dok im dobar može pomoći da lako nauče osnovne informacije o vašem programu.

Koraci

1 Uključite podatke za kontakt. Ovo je vjerojatno najvažniji dio Readme dokumenta. Podaci za kontakt omogućit će korisniku da vas kontaktira kako bi vam predložio dopunu programa, postavio pitanje, ispravio pogrešku ili platio program. Uključite naziv tvrtke, web stranicu, e -poštu i telefonski broj (ove će informacije potrajati nekoliko redaka).
- Primjer je prikazan na slici.
2 Umetnite datum u Readme. Ovo je mali, ali vrlo važan korak. Važno je označiti datum distribucije za vaš program. Na taj će način korisnici biti svjesni ažuriranja verzije programa te će također moći utvrditi je li još uvijek podržano.
3 Zabilježite naziv programa, verziju i podatke o cijenama. Pri vrhu upišite naziv aplikacije i broj verzije. Molimo dolje napišite cijenu za punu verziju. Ako program distribuirate pomoću fizičkih medija, poput CD -a, ne možete uključiti podatke o cijenama jer su korisnici vjerojatno već platili program.
4 Ukratko opišite program. Ukratko opišite svoj program u rečenici ili dvije. Na primjer: "Ova aplikacija prati raspoloženje korisnika analizirajući njegovu aktivnost na internetu, a zatim mijenja prostor na radnoj površini na takav način da se prilagodi emocionalnom stanju korisnika."
- Ako vaš softver ima prilično širok raspon značajki, možete proširiti opis za cijeli ili dva odlomka. Pomoću označenog popisa možete numerirati sve funkcije i značajke programa.
5 Opišite minimalne zahtjeve za program. Dobra datoteka Readme trebala bi sadržavati informacije o minimalnim zahtjevima za program i upute za instalaciju. Ako vam je za instaliranje programa potreban neki drugi softver, svakako ga navedite. Također možete uključiti informacije o preporučenim zahtjevima (na primjer, opterećenje CPU -a).
6 Uključite podatke o licenci i autorskim pravima. Na kraju ne zaboravite uključiti podatke o datumu utvrđivanja autorskih prava i licenciranju programa.

Savjeti

Da biste spriječili da korisnici moraju formatirati vašu datoteku, spremite je u običnom tekstu (.txt).
U ime datoteke Readme navedite naziv programa; stoga će korisnik tražiti datoteku Readme prema nazivu programa.