Kuinka kirjoittaa Readme

Sisältö

Askeleet
Vinkkejä
Mitä tarvitset

Readme -tiedosto on pieni asiakirja, joka yleensä sisältyy ohjelmaan. Lueminut -tiedostot ovat ohjelmistokehittäjien kirjoittamia, ja ne sisältävät perustietoja ohjelmasta, mukaan lukien asennustiedot tai opas järjestelmän asetuksiin, yhteystiedot, lisenssit, kiitokset ja ohjelmistoversiotiedot. Ohjelmistojen jakelussa on tärkeää tietää, miten Readme -tiedosto kirjoitetaan. Huonosti kirjoitettu Readme voi olla turhauttavaa ja väsyttävää käyttäjälle, kun taas hyvä voi auttaa heitä oppimaan helposti ohjelmasi perustiedot.

Askeleet

1 Sisällytä yhteystiedot. Tämä on luultavasti Readme -asiakirjan tärkein osa. Yhteystietojen avulla käyttäjä voi ottaa sinuun yhteyttä ehdottaakseen ohjelman täydentämistä, kysymyksen esittämistä, virheen korjaamista tai ohjelman maksamista. Liitä mukaan yrityksen nimi, verkkosivusto, sähköposti ja puhelinnumero (nämä tiedot vievät pari riviä).
- Esimerkki näkyy kuvassa.
2 Lisää päivämäärä Readme -laitteeseesi. Tämä on pieni mutta erittäin tärkeä askel. On tärkeää merkitä ohjelman jakelupäivä. Näin käyttäjät ovat tietoisia ohjelman versiopäivityksistä ja voivat myös määrittää, tuetaanko sitä edelleen.
3 Kirjoita muistiin ohjelman nimi, versio ja hintatiedot. Kirjoita yläosaan sovelluksen nimi ja versionumero. Kirjoita täyden version hinta alle. Jos jaat ohjelmaa fyysisellä välineellä, kuten CD -levyllä, et välttämättä sisällytä hintatietoja, koska käyttäjät ovat todennäköisesti jo maksaneet ohjelmasta.
4 Kuvaile ohjelma lyhyesti. Anna lyhyt kuvaus ohjelmastasi lauseella tai kahdella. Esimerkki: "Tämä sovellus seuraa käyttäjän mielialaa analysoimalla hänen toimintaa Internetissä ja muuttaa sitten työpöydän tilaa siten, että se mukautuu käyttäjän emotionaaliseen tilaan."
- Jos ohjelmistossasi on melko laaja valikoima ominaisuuksia, voit laajentaa kuvausta kokonaisella kappaleella. Voit käyttää luettelomerkintää ohjelman kaikkien toimintojen ja ominaisuuksien numeroimiseen.
5 Kuvaile ohjelman vähimmäisvaatimukset. Hyvässä Readme -tiedostossa on oltava tietoja ohjelman vähimmäisvaatimuksista ja asennusohjeet. Jos tarvitset toisen ohjelmiston ohjelman asentamiseen, muista mainita se. Voit myös sisällyttää tietoja suositelluista vaatimuksista (esimerkiksi suorittimen kuormituksesta).
6 Sisällytä lisenssi- ja tekijänoikeustiedot. Lopuksi, älä unohda sisällyttää tietoja tekijänoikeuden ja ohjelman lisensoinnin päivämäärästä.

Vinkkejä

Jos haluat estää käyttäjiä muotoilemasta tiedostoasi, tallenna se tekstimuodossa (.txt).
Lisää Readme -tiedoston nimeen ohjelman nimi; Näin käyttäjä etsii Readme -tiedostoa ohjelman nimen perusteella.