Vsebina

• Koraki
• Nasveti
• Kaj potrebujete

Datoteka Readme je majhen dokument, ki je običajno vključen v program. Datoteke Readme so napisali razvijalci programske opreme in vsebujejo osnovne informacije o programu, vključno z informacijami o namestitvi ali vodnikom po sistemskih nastavitvah, kontaktnimi podatki, licencami, pohvalami in različicami programske opreme. Za distribucijo programske opreme je pomembno vedeti, kako napisati datoteko Readme. Slabo napisan Readme je lahko za uporabnika frustrirajoč in dolgočasen, dober pa mu lahko pomaga enostavno naučiti osnovnih informacij o vašem programu.

Koraki

1. 1 Vključite podatke za stik. To je verjetno najpomembnejši del dokumenta Readme. Kontaktni podatki bodo uporabniku omogočili, da stopi v stik z vami, da vam predlaga, da dopolnite program, zastavite vprašanje, popravite napako ali plačate program. Vključite ime podjetja, spletno mesto, e -pošto in telefonsko številko (ti podatki bodo v nekaj vrsticah).
   • Primer je prikazan na sliki.
2. 2 Datum vstavite v svoj Readme. To je majhen, a zelo pomemben korak. Pomembno je, da označite datum distribucije svojega programa. Tako bodo uporabniki seznanjeni s posodobitvami različic programa in bodo lahko tudi ugotovili, ali je še vedno podprta.
3. 3 Zapišite si ime programa, različico in podatke o cenah. Na vrhu napišite ime aplikacije in številko različice. Spodaj napišite ceno za celotno različico. Če program distribuirate z uporabo fizičnih medijev, kot je CD, podatkov o cenah ne smete vključiti, ker so uporabniki program verjetno že plačali.
4. 4 Na kratko opišite program. Na kratko opišite svoj program v stavku ali dveh. Na primer: "Ta aplikacija spremlja razpoloženje uporabnika z analizo njegove dejavnosti v internetu, nato pa spremeni prostor na namizju tako, da se prilagodi čustvenemu stanju uporabnika."
   • Če ima vaša programska oprema precej širok nabor funkcij, lahko opis razširite za celoten odstavek ali dva. Za označevanje vseh funkcij in funkcij programa lahko uporabite označeni seznam.
5. 5 Opišite minimalne zahteve za program. Dobra datoteka Readme mora vsebovati informacije o minimalnih zahtevah za program in navodila za namestitev. Če za namestitev programa potrebujete drugo programsko opremo, jo omenite. Vključite lahko tudi informacije o priporočenih zahtevah (na primer obremenitev procesorja).
6. 6 Vključite podatke o licenci in avtorskih pravicah. Na koncu ne pozabite vključiti podatkov o datumu ustanovitve avtorskih pravic in licenciranju programa.

Nasveti

• Če želite preprečiti, da bi morali uporabniki formatirati datoteko, jo shranite v navadnem besedilu (.txt).
• V ime datoteke Readme vključite ime programa; tako bo uporabnik iskal datoteko Readme po imenu programa.

Kaj potrebujete

• Računalnik
• Urejevalnik besedil