Readme кантип жазуу керек

Мазмун

Кадамдар
Кеңештер
Сага эмне керек

Readme файлы, адатта, программага кошулган кичинекей документ. Readme файлдары программалык камсыздоону иштеп чыгуучулар тарабынан жазылган жана программа жөнүндө негизги маалыматты камтыйт, анын ичинде орнотуу маалыматы же тутумдун орнотуулары, байланыш маалыматы, лицензия, мактоолор жана программалык камсыздоонун версиясы боюнча маалымат. Программалык камсыздоону бөлүштүрүү үчүн Readme файлын кантип жазууну билүү маанилүү. Туура эмес жазылган Readme колдонуучуну капалантат жана чарчатат, ал эми жакшы программа программаңыз жөнүндө негизги маалыматты оңой үйрөнүүгө жардам берет.

Кадамдар

1 Байланыш маалыматын кошуңуз. Бул, балким, Readme документинин эң маанилүү бөлүгү. Байланыш маалыматы колдонуучуга программаны толуктоону, суроо берүүнү, катаны оңдоону же программаны төлөөнү сунуштоо үчүн сиз менен байланышууга мүмкүнчүлүк берет. Компаниянын атын, веб -сайтын, электрондук почтасын жана телефон номерин кошуңуз (бул маалымат бир нече сапты камтыйт).
- Мисал сүрөттө көрсөтүлгөн.
2 Күндү Readmeге киргизиңиз. Бул кичинекей, бирок абдан маанилүү кадам. Программаңыздын таркатылган күнүн белгилөө маанилүү. Ошентип, колдонуучулар программанын версиясын жаңыртуулардан кабардар болушат жана ал дагы эле колдоого алынганын аныктай алышат.
3 Программанын атын, версиясын жана баа маалыматын жазып алыңыз. Үстүнкү жагына колдонмонун атын жана версиянын номерин жазыңыз. Толук версиясынын баасын төмөнгө жазыңыз. Эгерде сиз программаны CD сыяктуу физикалык каражаттарды колдонуу менен жайылтсаңыз, анда баалар тууралуу маалыматты кошпошуңуз мүмкүн, анткени колдонуучулар буга чейин программаны төлөшкөн.
4 Программаны кыскача сүрөттөп бериңиз. Программаңызга кыскача сүрөттөмөнү бир же эки сүйлөм менен бериңиз. Мисалы: "Бул тиркеме колдонуучунун маанайын интернеттеги ишмердүүлүгүн анализдөө аркылуу көзөмөлдөйт, андан кийин колдонуучунун эмоционалдык абалына ылайыкташтырылган түрдө иш столундагы мейкиндикти өзгөртөт."
- Эгерде сиздин программалык камсыздоонуңуздун кеңири спектри бар болсо, анда сүрөттөмөнү бир же эки пунктка узарта аласыз. Сиз программанын бардык функцияларын жана өзгөчөлүктөрүн номерлөө үчүн маркерленген тизме колдоно аласыз.
5 Программа үчүн минималдуу талаптарды сүрөттөп бериңиз. Жакшы Readme файлы программанын минималдуу талаптары жана орнотуу боюнча көрсөтмөлөрдү камтышы керек. Эгерде сизге программаны орнотуу үчүн башка программа керек болсо, аны сөзсүз түрдө белгилеңиз. Сиз ошондой эле сунушталган талаптар жөнүндө маалыматты кошо аласыз (мисалы, CPU жүктөмү).
6 Лицензия жана автордук укук маалыматын кошуңуз. Акырында, автордук укуктун түзүлгөн күнү жана программаны лицензиялоо жөнүндө маалыматты киргизүүнү унутпаңыз.

Кеңештер

Колдонуучулар сиздин файлды форматташына жол бербөө үчүн, аны жөнөкөй текст (.txt) форматында сактаңыз.
Readme файлынын атына программанын атын кошуңуз; Ошентип, колдонуучу Readme файлын программанын аты менен издейт.