Hogyan írjunk Readme -t

Tartalom

Lépések
Tippek
Mire van szükséged

A Readme fájl egy kisméretű dokumentum, amelyet általában egy program tartalmaz. A Readme fájlokat a szoftverfejlesztők írták, és alapvető információkat tartalmaznak egy programról, beleértve a telepítési információkat vagy a rendszerbeállítások útmutatóját, az elérhetőségi adatokat, a licencet, a dicséreteket és a szoftververzió adatait. A szoftverterjesztéshez fontos tudni, hogyan kell írni a Readme fájlt. A rosszul megírt Readme frusztráló és fárasztó lehet a felhasználó számára, míg egy jó segíthet abban, hogy könnyen elsajátítsa a programmal kapcsolatos alapvető információkat.

Lépések

1 Adja meg az elérhetőségi adatokat. Ez valószínűleg a Readme dokumentum legfontosabb része. A kapcsolatfelvételi adatok lehetővé teszik a felhasználó számára, hogy felvegye Önnel a kapcsolatot, hogy javaslatot tegyen a program kiegészítésére, kérdéseket tegyen fel, hibát javítson vagy fizessen a programért. Adja meg a cég nevét, webhelyét, e -mail címét és telefonszámát (ez az információ néhány sort vesz igénybe).
- Egy példa látható a képen.
2 Illessze be a dátumot a Readme -be. Ez egy kicsi, de nagyon fontos lépés. Fontos, hogy jelölje meg a program terjesztési dátumát. Így a felhasználók tisztában lesznek a programverzió frissítésével, és meg tudják állapítani, hogy továbbra is támogatott -e.
3 Jegyezze fel a program nevét, verzióját és árazási adatait. A tetejére írja be az alkalmazás nevét és verziószámát. Kérjük, írja le a teljes verzió árát alább. Ha a programot fizikai adathordozón, például CD -n terjeszti, előfordulhat, hogy nem tartalmazza az árazási információkat, mert a felhasználók valószínűleg már fizettek a programért.
4 Röviden írja le a programot. Írjon rövid leírást programjáról egy -két mondatban. Például: "Ez az alkalmazás nyomon követi a felhasználó hangulatát az interneten végzett tevékenységének elemzésével, majd megváltoztatja az asztalon a teret oly módon, hogy alkalmazkodjon a felhasználó érzelmi állapotához."
- Ha a szoftver meglehetősen széles körű funkciókkal rendelkezik, akkor a leírást egy vagy két bekezdéssel kiterjesztheti. Felsorolt listával számozhatja a program összes funkcióját és funkcióját.
5 Ismertesse a program minimális követelményeit. Egy jó Readme fájlnak tartalmaznia kell információkat a program minimális követelményeiről és a telepítési utasításokat. Ha egy másik szoftverre van szüksége a program telepítéséhez, feltétlenül említse meg. A javasolt követelményekről (például CPU -terhelésről) információkat is megadhat.
6 Tartalmazza a licenc- és szerzői jogi információkat. A végén ne felejtse el megadni a szerzői jog létrehozásának és a program engedélyezésének dátumát.

Tippek

Annak érdekében, hogy a felhasználóknak ne kelljen formázniuk a fájlt, mentse azt egyszerű szöveg (.txt) formátumban.
A Readme fájl nevében adja meg a program nevét; így a felhasználó a program neve alapján fogja keresni a Readme fájlt.