Hogyan kell írni Readme: 6 lépés -

A README fájl egy kis dokumentum, amelyet általában a programhoz csatolnak.A README fájlokat a szoftverfejlesztők írják, és alapvető információkat tartalmaznak a programról, beleértve a telepítési adatokat vagy a rendszerbeállításokat, a kapcsolattartási információkat, az engedélyt, a hálát és a verzióra vonatkozó információkat.A szoftver forgalmazásához fontos tudni, hogyan kell írni a README fájlt. A rosszul írott README dokumentum csalódást okozhat, a felhasználó gumiabroncsának, míg a sikeres opció segít neki könnyedén megtanulni az alapvető információkat a programról.

Lépések

A kép címe Írjon egy olvasni, 1. lépés 1. lépés

egy. Kapcsolatfelvétel engedélyezése.Ez valószínűleg a README dokumentum legfontosabb része.Az elérhetőségi adatok lehetővé teszik a felhasználó számára, hogy lépjen kapcsolatba veled, hogy felajánlja Önt, hogy kiegészítse a programot, kérdezzen meg egy kérdést, javítsa ki a hibát, vagy fizesse meg a programot. Tartalmazza a cég nevét, webhelyét, e-mailjét és telefonszámát (ez az információ egy pár húrot vesz igénybe).

A képen látható egy példa.

A kép, amelyet írni egy Olvassa el a 2. lépést

2. Helyezze be a Dátumot a Readme-ben.Ez egy kis, de nagyon fontos lépés.Fontos, hogy kijelölje a program elosztási dátumát. Így a felhasználók tisztában lesznek a program verziójának frissítéseinek, és képesek lesznek meghatározni, hogy eddig támogatott-e.

A kép, amelyet írni egy Olvassa el a 3. lépést

3. Jegyezze fel a program nevét, verzióját és árinformációit.Az emeleten írja be az alkalmazás nevét és a verziószámot.Alább írja be az árat a teljes verzióra. Ha a programot fizikai médiával, például CD-vel terjeszti, akkor nem tartalmazhat árinformációkat, mert a felhasználók valószínűleg már kifizetettek a programért.

4. Röviden írja le a programot.Egy két mondatban adja meg a program rövid leírását.Például: "Ez az alkalmazás figyelemmel kíséri a felhasználó hangulatát, elemezve tevékenységét az interneten, majd az asztalon lévő helyet oly módon változik, hogy módosítsa a felhasználó érzelmi állapotát."

Ha a szoftvernek meglehetősen széles körű funkciója van, akkor a leírást egy egész vagy kettőre bővítheti. Jelölt listát használhat a program összes funkciójának és funkcióinak számához.

A kép címe Írja le olvasni, hogy 5. lépés

öt. Ismertesse a program minimumkövetelményeit.Egy jó README fájlban tájékoztatást kell adnia a program és a telepítési utasítások minimumkövetelményeiről.Ha szüksége van a szoftver egy másik részére a program telepítéséhez, ne felejtse el megemlíteni. Az ajánlott követelményeket is tartalmazhat (például a CPU letöltése).

A kép, amelyet írni egy Olvassa el a 6. lépést

6. Engedélyezze az engedélyt és a szerzői jogi információkat. A végén ne felejtsük el adni a szerzői jogi és engedélyezési program dátumát.

Tippek

Ha nem kell formáznia a fájlt, mentse egyszerű szöveges formátumban (.Txt).
A README fájlnévben engedélyezze a program nevét - így a felhasználó megkeresi a README fájlt a program nevével.

Amire szükséged van

Számítógép
Szöveg szerkesztő