Si të shkruani një Readme

Përmbajtje

Hapa
Këshilla
Cfare te nevojitet

Një skedar Readme është një dokument i vogël që zakonisht përfshihet me një program. Dosjet Readme shkruhen nga zhvilluesit e programeve kompjuterike dhe përmbajnë informacionin bazë në lidhje me një program, duke përfshirë informacionin e instalimit ose një udhëzues për cilësimet e sistemit, informacionin e kontaktit, licencën, lavdërimet dhe informacionin e versionit të softuerit. Për shpërndarjen e softuerit, është e rëndësishme të dini se si të shkruani skedarin Readme. Një Readme e shkruar dobët mund të jetë zhgënjyese dhe e lodhshme për përdoruesit, ndërsa një e mirë mund t'i ndihmojë ata të mësojnë me lehtësi informacionin bazë në lidhje me programin tuaj.

Hapa

1 Përfshini informacionin e kontaktit. Kjo është ndoshta pjesa më e rëndësishme e dokumentit Readme. Informacioni i kontaktit do t'i lejojë përdoruesit t'ju kontaktojë në mënyrë që t'ju sugjerojë të plotësoni programin, të bëni një pyetje, të korrigjoni një gabim ose të paguani për programin. Përfshini emrin e kompanisë, uebfaqen, Emailin dhe numrin e telefonit (ky informacion do të marrë disa rreshta).
- Një shembull është treguar në figurë.
2 Futni datën në Readme tuaj. Ky është një hap i vogël por shumë i rëndësishëm. Shtë e rëndësishme të shënoni datën e shpërndarjes për programin tuaj. Në këtë mënyrë, përdoruesit do të jenë të vetëdijshëm për përditësimet e versionit të programit dhe gjithashtu do të jenë në gjendje të përcaktojnë nëse është ende i mbështetur.
3 Shënoni emrin e programit, versionin dhe informacionin e çmimeve. Në krye, shkruani emrin e aplikacionit dhe numrin e versionit. Ju lutemi shkruani çmimin për versionin e plotë më poshtë. Nëse shpërndani programin duke përdorur media fizike të tilla si CD, mund të mos përfshini informacionin e çmimit sepse përdoruesit ka të ngjarë të kenë paguar tashmë për programin.
4 Përshkruani shkurtimisht programin. Jepni një përshkrim të shkurtër të programit tuaj në një ose dy fjali. Për shembull: "Ky aplikacion gjurmon gjendjen shpirtërore të përdoruesit duke analizuar aktivitetin e tij në internet dhe më pas ndryshon hapësirën në desktop në mënyrë të tillë që të përshtatet me gjendjen emocionale të përdoruesit."
- Nëse softueri juaj ka një gamë mjaft të gjerë karakteristikash, mund ta zgjeroni përshkrimin me një ose dy paragrafë të tërë. Ju mund të përdorni një listë me pika për të numëruar të gjitha funksionet dhe veçoritë e programit.
5 Përshkruani kërkesat minimale për programin. Një skedar i mirë Readme duhet të përmbajë informacion në lidhje me kërkesat minimale për programin dhe udhëzimet për instalim. Nëse keni nevojë për një program tjetër për të instaluar programin, sigurohuni që ta përmendni atë. Ju gjithashtu mund të përfshini informacion në lidhje me kërkesat e rekomanduara (për shembull, ngarkesa e CPU).
6 Përfshini informacionin e licencës dhe të drejtën e autorit. Në fund, mos harroni të përfshini informacion në lidhje me datën e krijimit të së drejtës së autorit dhe licencimin e programit.

Këshilla

Për të parandaluar që përdoruesit të formatojnë skedarin tuaj, ruajeni atë në format të thjeshtë teksti (.txt).
Në emrin e skedarit Readme, përfshini emrin e programit; kështu, përdoruesi do të kërkojë skedarin Readme me emrin e programit.