Turinys

• Žingsniai
• Patarimai
• Ko tau reikia

„Readme“ failas yra mažas dokumentas, kuris paprastai yra įtrauktas į programą. „Readme“ failus rašo programinės įrangos kūrėjai ir juose yra pagrindinės informacijos apie programą, įskaitant diegimo informaciją arba sistemos nustatymų vadovą, kontaktinę informaciją, licenciją, pagyrimus ir programinės įrangos versijos informaciją. Programinės įrangos platinimui svarbu žinoti, kaip parašyti „Readme“ failą. Prastai parašyta „Readme“ gali varginti ir varginti vartotoją, o gera - padėti jiems lengvai sužinoti pagrindinę informaciją apie jūsų programą.

Žingsniai

1. 1 Įtraukite kontaktinę informaciją. Tai turbūt svarbiausia „Readme“ dokumento dalis. Kontaktinė informacija leis vartotojui susisiekti su jumis, kad pasiūlytų jums papildyti programą, užduoti klausimą, ištaisyti klaidą ar sumokėti už programą. Įtraukite įmonės pavadinimą, svetainę, el. Pašto adresą ir telefono numerį (ši informacija užtruks kelias eilutes).
   • Pavyzdys parodytas paveikslėlyje.
2. 2 Įveskite datą į „Readme“. Tai mažas, bet labai svarbus žingsnis. Svarbu pažymėti savo programos platinimo datą. Tokiu būdu vartotojai žinos apie programos versijos atnaujinimus ir taip pat galės nustatyti, ar ji vis dar palaikoma.
3. 3 Užsirašykite programos pavadinimą, versiją ir informaciją apie kainas. Viršuje parašykite programos pavadinimą ir versijos numerį. Žemiau parašykite visos versijos kainą. Jei platinate programą naudodami fizinę laikmeną, pvz., Kompaktinį diską, galite neįtraukti kainų informacijos, nes vartotojai tikriausiai jau sumokėjo už programą.
4. 4 Trumpai apibūdinkite programą. Trumpai ar du sakiniais apibūdinkite savo programą. Pavyzdžiui: „Ši programa stebi vartotojo nuotaiką analizuodama jo veiklą internete, o tada pakeičia darbalaukio erdvę taip, kad prisitaikytų prie vartotojo emocinės būsenos“.
   • Jei jūsų programinė įranga turi gana platų funkcijų spektrą, galite išplėsti aprašą visa pastraipa ar dviem. Galite naudoti sąrašą su ženkleliais, kad numeruotumėte visas programos funkcijas ir funkcijas.
5. 5 Apibūdinkite minimalius programos reikalavimus. Gerame „Readme“ faile turėtų būti informacija apie minimalius programos reikalavimus ir diegimo instrukcijos. Jei programai įdiegti reikia kitos programinės įrangos, būtinai ją paminėkite. Taip pat galite įtraukti informaciją apie rekomenduojamus reikalavimus (pvz., Procesoriaus apkrovą).
6. 6 Įtraukite licencijos ir autorių teisių informaciją. Pabaigoje nepamirškite įtraukti informacijos apie autorių teisių nustatymo ir programos licencijavimo datą.

Patarimai

• Kad vartotojams nereikėtų formatuoti jūsų failo, išsaugokite jį paprasto teksto (.txt) formatu.
• „Readme“ failo pavadinime nurodykite programos pavadinimą; taigi vartotojas ieškos „Readme“ failo pagal programos pavadinimą.

Ko tau reikia

• Kompiuteris
• Teksto redaktorius