Как да пиша Readme: 6 стъпки

Файлът ReadMe е малък документ, който обикновено е приложен към програмата.README файловете са написани от разработчиците на софтуер и съдържат основна информация за програмата, включително инсталационни данни или настройки на системата, информация за контакт, лиценз, благодарност и информация за версията.За да разпространявате софтуер, важно е да знаете как да напишете README файл. Лошописаният документ за readme може да разочарова, да губят потребителя, докато успешната опция ще му помогне с лекота на науката основната информация за вашата програма.

Стъпка

един. Активиране на информация за контакт.Това е може би най-важната част от документа за readme.Информацията за контакт ще позволи на потребителя да се свърже с вас, за да ви предложи да допълнете програмата, да зададете въпрос, да коригирате грешката или да платите програмата. Включете името на фирмата, уебсайта, имейла и телефонния номер (тази информация ще вземе двойка струни).

Пример за пример е показан на снимката.

Изображение, озаглавено пишете ми стъпка 2

2. Поставете датата във вашия readme.Това е малка, но много важна стъпка.Важно е да се определи датата на разпространение на вашата програма. Така че потребителите ще бъдат наясно с актуализациите на версията на програмата и също така ще могат да определят дали тя се поддържа досега.

Изображение, озаглавено пишете ми стъпка 3

3. Запишете името на програмата, версията и информацията за цените.Нагоре Напишете името на приложението и номера на версията.По-долу напишете цената за пълната версия. Ако разпространявате програмата с физическа среда, като CD, не можете да включите информация за цената, защото потребителите вероятно вече са платили за програмата.

Изображение, озаглавено пишете ми стъпка 4

4. Накратко опишете програмата.В една-две изречения, дайте кратко описание на вашата програма.Например: "Това приложение следи настроението на потребителя, анализирайки дейността си в интернет, след което пространството на работния плот се променя по такъв начин, че да коригира емоционалното състояние на потребителя."

Ако вашият софтуер има доста широк списък с функции, можете да разширите описанието към цял параграф или две. Можете да използвате маркиран списък, за да носите всички функции и функции на програмата.

Изображение, озаглавено Пишете ми стъпка 5

пет. Опишете минималните изисквания за програмата.В добър README файл трябва да има информация относно минималните изисквания за инструкциите за програмиране и инсталиране.Ако имате нужда от друга част от софтуера, за да инсталирате програмата, не забравяйте да го споменете. Можете също така да включите информация за препоръчаните изисквания (например, CPU изтегляне).

Изображение, озаглавено пишете ми стъпка 6

6. Активиране на информацията за лиценза и авторското право. В крайна сметка не забравяйте да въведете информация за датата на авторското право и лицензионната програма.

Съвети

За да не трябва да форматирате файла си, запазете го в прост текстов формат (.ТЕКСТ).
В името на файла readme активирайте името на програмата - така че потребителят ще търси файла README по името на програмата.

От какво имаш нужда

Компютър
Текстов редактор