Як написати readme: 6 кроків

Файл Readme - це невеликий за обсягом документ, який зазвичай додається до програми.Файли Readme пишуться розробниками програмного забезпечення та містять базову інформацію про програму, включаючи дані про встановлення або керівництво про системні налаштуваннях, контактну інформацію, ліцензію, подяки і інформацію про версію ПЗ.Для поширення програмного забезпечення важливо знати, як слід писати файл Readme. Погано написаний документ Readme може розчарувати, втомити користувача, в той час як вдалий варіант допоможе йому з легкістю дізнатися базову інформацію про вашу програму.

кроки

1. Увімкніть контактну інформацію.Це, ймовірно, найважливіша частина документа Readme.Контактна інформація дозволить користувачеві зв`язатися з вами, щоб запропонувати вам доповнити програму, задати питання, виправити помилку або оплатити програму. Увімкніть назву компанії, вебсайт, Email і телефонний номер (ця інформація займе пару рядків).

Приклад наведено на зображенні.

2. Вставте дату в ваш Readme.Це невеликий, але дуже важливий крок.Важливо позначити дату поширення вашої програми. Так користувачі будуть в курсі оновлень версії програми, а також зможуть визначити, чи підтримується вона до сих пір.

3. Запишіть назву програми, версію та інформацію про ціну.Нагорі напишіть назву програми і номер версії.Нижче напишіть ціну за повну версію. Якщо ви поширюєте програму за допомогою фізичних носіїв, таких як CD, можете не включати інформацію про ціну, тому що користувачі, ймовірно, вже і так заплатили за програму.

4. Коротко опишіть програму.В одному-двох реченнях дайте короткий опис вашої програми.Наприклад: "Цей додаток відстежує настрій користувача, аналізуючи його активність в інтернеті, після чого змінює простір на робочому столі таким чином, щоб підлаштуватися під емоційний стан користувача."

Якщо у вашого програмного забезпечення досить широкий список функцій, можете розширити опис на цілий абзац або два. Можете використовувати маркований список, щоб пронумерувати всі функції і можливості програми.

5. Опишіть мінімальні вимоги для програми.В хорошому файлі Readme повинна бути інформація, що стосується мінімальних вимог для програми і інструкції по установці.Якщо для установки програми потрібна ще одна частина програмного забезпечення, не забудьте згадати про це. Ви також можете включити інформацію про рекомендованих вимогах (наприклад, завантаження CPU).

6. Включіть інформацію про ліцензії та авторські права. В кінці не забудьте вписати інформацію про дату встановлення авторського права і ліцензування програми.

Поради

Щоб користувачам не треба було форматувати ваш файл, збережіть його в простому текстовому форматі (.txt).
У назва файлу Readme включите назву програми- таким чином, користувач буде шукати файл Readme за назвою програми.

Що вам знадобиться

комп`ютер
Текстовий редактор