Loe mind fail (nimetatakse ka lugemiseks) on lühike kirjalik dokument, mida levitatakse koos tarkvaraosaga. Loe mind failid on kirjutanud tarkvara arendajad ja need sisaldavad põhilist olulist teavet tarkvara kohta, sealhulgas installi- või konfigureerimisjuhiseid, kontaktteavet, litsentsiteavet, kinnitusi ja teavet tarkvara versiooni kohta. Lugege mind kirjutama õppimine on tarkvara tõhusa levitamise jaoks ülioluline. Halb loe mind-fail võib teie kasutajat häirida, segadusse ajada või tüüta, samas kui tõhus fail võib anda neile kiiresti teie programmi põhiteadmised.
1
Lisage kontaktandmete loend. See on võib-olla minu lugemise kõige olulisem osa. Kontaktteave võimaldab kasutajatel teiega ühendust võtta, et soovitada funktsioone, esitada küsimusi, teatada vigadest või teha tarkvara eest makseid. Lisage mõne rea abil ettevõtte nimi, veebisait, e-posti aadress ja telefoninumber. Kontaktide jaotise näide võib välja näha järgmine:
2
Lisage kuupäev, kui loete mind. See on väike, kuid oluline samm. Lisage üks rida, millel on tarkvara levitamise aasta. See hoiatab kasutajaid, et nad kontrolliksid uuemat versiooni või veenduksid, et rakendus oleks endiselt toetatud, kui kuupäev pole värske.
3
Lisage oma tarkvara nimi, versioon ja hinnateave. Lisage loe mind faili ülaossa rida rakenduse nime ja versiooninumbriga. Selle alla lisage rida täisversiooni hinnaga. Kui levitate tarkvara füüsilise andmekandja (nt CD) abil, võite hinnateabe välja jätta, kuna teie kasutaja on tõenäoliselt tarkvara eest juba maksnud.
4
Kirjeldage tarkvara lühidalt ja mõjuvalt. Kasutades ainult ühte või kahte lauset, lisage programmi lühikirjeldus. Näide võib olla järgmine: “See rakendus määrab kasutaja meeleolu, logides sisse tema tegevused võrgus, seejärel muudab töölauakeskkonda vastavalt sellele meeleolule.” Kui teie tarkvararakendusel on laiem funktsioonide loend, saate kirjeldust laiendada lõiguks või enamaks. . Kaaluge täpploendite kasutamist programmi funktsioonide või võimaluste loetlemiseks.
5
Esitage oma programmile põhilised installinõuded. Hea loe mind fail peaks sisaldama ka teavet süsteeminõuete ja installijuhiste kohta. Kui programmi käitamiseks on vaja mõnda muud tarkvara, mainige seda siin. Saate lisada ka teavet eeldatava ressursikasutuse kohta (nt protsessori kasutus).
6
Kaasake autoriõiguse või litsentsi teave. Lõpuks sisestage kindlasti autoriõiguse kuupäev ja milline tarkvara litsentsileping reguleerib programmi kasutamist.