Hvernig á að skrifa Readme

Efni.

Skref
Ábendingar
Hvað vantar þig

Readme skrá er lítið skjal sem venjulega fylgir forriti. Readme skrár eru skrifaðar af hugbúnaðarframleiðendum og innihalda grunnupplýsingar um forrit, þar á meðal upplýsingar um uppsetningu eða leiðbeiningar um kerfisstillingar, upplýsingar um tengiliði, leyfi, hrós og upplýsingar um hugbúnaðarútgáfur. Fyrir dreifingu hugbúnaðar er mikilvægt að vita hvernig á að skrifa Readme skrána. Lítið skrifað lesbók getur verið pirrandi og þreytandi fyrir notandann, en góð leið getur hjálpað þeim að læra auðveldlega grunnupplýsingarnar um forritið þitt.

Skref

1 Hafa samband upplýsingar. Þetta er líklega mikilvægasti þátturinn í Readme skjalinu. Tengiliðaupplýsingarnar munu leyfa notandanum að hafa samband við þig til að benda þér á að bæta við forritinu, spyrja spurningar, leiðrétta villu eða borga fyrir forritið. Látið nafn fyrirtækis, vefsíðu, netfang og símanúmer fylgja með (þessar upplýsingar taka nokkrar línur).
- Dæmi er sýnt á myndinni.
2 Settu dagsetninguna inn í Readme þinn. Þetta er lítið en mjög mikilvægt skref. Það er mikilvægt að merkja dreifingardag fyrir forritið þitt. Þannig verða notendur meðvitaðir um uppfærslur á útgáfu forrita og geta einnig ákvarðað hvort það er enn stutt.
3 Skráðu nafnið á forritinu, útgáfu og verðupplýsingar. Efst, skrifaðu nafn forritsins og útgáfunúmer. Vinsamlegast skrifaðu verðið fyrir fulla útgáfu hér að neðan. Ef þú dreifir forritinu með því að nota líkamlega fjölmiðla eins og geisladisk, getur verið að þú sért ekki með verðlagningarupplýsingarnar því notendur hafa líklega þegar greitt fyrir forritið.
4 Lýstu dagskránni í stuttu máli. Gefðu stutta lýsingu á forritinu þínu í setningu eða tveimur. Til dæmis: "Þetta forrit fylgist með skapi notandans með því að greina virkni hans á Netinu og breyta síðan rýminu á skjáborðinu þannig að það aðlagast tilfinningalegu ástandi notandans."
- Ef hugbúnaðurinn þinn er með nokkuð breitt úrval af eiginleikum geturðu lengt lýsinguna um heila málsgrein eða tvær. Þú getur notað punktalista til að númera allar aðgerðir og eiginleika forritsins.
5 Lýstu lágmarkskröfum fyrir forritið. Góð Readme skrá ætti að innihalda upplýsingar um lágmarkskröfur fyrir forritið og leiðbeiningar um uppsetningu. Ef þú þarft annan hugbúnað til að setja upp forritið, vertu viss um að nefna það. Þú getur einnig innihaldið upplýsingar um ráðlagðar kröfur (til dæmis CPU hleðsla).
6 Hafa upplýsingar um leyfi og höfundarrétt. Í lokin, ekki gleyma að innihalda upplýsingar um upphafsdag höfundarréttar og leyfi fyrir forritinu.

Ábendingar

Til að koma í veg fyrir að notendur þurfi að forsníða skrána skaltu vista hana í venjulegu texta (.txt) sniði.
Í heiti Readme skráarinnar, innihalda nafnið á forritinu; þannig mun notandinn leita að Readme skrá með nafni forritsins.