Jak pisać Readme: 6 kroków

Plik README to mały dokument, który jest zwykle podłączony do programu.Pliki Readme są zapisywane przez programistów oprogramowania i zawierają podstawowe informacje o programie, w tym danych instalacyjnych lub ustawień systemu, dane kontaktowe, licencję, wdzięczność i informacje o wersji.Aby dystrybuować oprogramowanie, ważne jest, aby wiedzieć, jak napisać plik README. Słabo napisany dokument README może rozczarować, opierać użytkownika, podczas gdy udana opcja pomoże mu z łatwością nauczyć się podstawowych informacji o programie.

Kroki

Obraz zatytułowany Napisz do mnie krok 1

jeden. Włącz dane kontaktowe.Jest to prawdopodobnie najważniejsza część dokumentu Readme.Informacje kontaktowe pozwolą użytkownikowi skontaktować się z Tobą, aby zaoferować, aby uzupełnić program, zadać pytanie, poprawić błąd lub zapłacić program. Dołącz nazwę firmy, stronę internetową, e-mail i numer telefonu (te informacje zajmą parę łańcuchów).

Przykład jest wyświetlany na zdjęciu.

Obraz zatytułowany Napisz do mnie krok 2

2. Włóż datę w swoim readme.To mały, ale bardzo ważny krok.Ważne jest, aby wyznaczyć datę dystrybucji programu. Więc użytkownicy będą świadomi aktualizacji wersji programu, a także będą mogły ustalić, czy tak daleko jest obsługiwane.

Obraz zatytułowany Napisz do mnie krok 3

3. Zapisz nazwę programu, wersji i informacji.Na górze Napisz nazwę aplikacji i numer wersji.Poniżej wpisz cenę za pełną wersję. Jeśli dystrybuujesz program za pomocą nośników fizycznych, takich jak CD, nie zawiera informacji o cenie, ponieważ użytkownicy prawdopodobnie już zapłacili za program.

Obraz zatytułowany Napisz do mnie krok 4

cztery. Krótko opisz program.W jeden-dwóch zdaniach podaj krótki opis swojego programu.Na przykład: "Ta aplikacja monitoruje nastrój użytkownika, analizując swoją aktywność w Internecie, po którym przestrzeń na pulpicie zmienia się w taki sposób, aby dostosować stan emocjonalny użytkownika."

Jeśli oprogramowanie ma dość szeroką listę funkcji, możesz rozszerzyć opis na cały akapit lub dwa. Możesz użyć zaznaczonej listy, aby liczba wszystkich funkcji i funkcji programu.

Obraz zatytułowany Napisz do mnie krok 5

pięć. Opisz minimalne wymagania dotyczące programu.W dobrym pliku Readme muszą istnieć informacje dotyczące minimalnych wymagań dotyczących instrukcji programu i instalacji.Jeśli potrzebujesz innej części oprogramowania, aby zainstalować program, nie zapomnij o tym wspomnieć. Możesz także zawierać informacje na temat zalecanych wymagań (na przykład do pobrania procesora).

6. Włącz informacje o licencji i prawach autorskich. Na koniec nie zapomnij wprowadzić informacji na temat daty programu praw autorskich i licencjonowania.

Rada

Nie trzeba sformatować swojego pliku, zapisz go w prostym formacie tekstowym (.TEKST).
W nazwie pliku Readme włącz nazwę programu - aby użytkownik wyszuka plik README według nazwy programu.

Czego potrzebujesz

Komputer
Edytor tekstu