Ako písať ReadMe: 6 krokov -

Súbor README je malý dokument, ktorý je zvyčajne pripojený k programu.Readme súbory sú napísané vývojármi softvéru a obsahujú základné informácie o programe, vrátane inštalačných údajov alebo systémových nastavení, kontaktných informácií, licencie, vďačnosti a informácií o verzii.Ak chcete distribuovať softvér, je dôležité vedieť, ako napísať súbor Readme. Zlyhaný písomný dokument ReadMe dokáže sklamať, na pneumatiku používateľa, zatiaľ čo úspešná možnosť mu pomôže s ľahkosťou naučiť základné informácie o vašom programe.

Kroky

Obrázok s názvom Napíšte si prečítať ma krok 1

jeden. Povoliť kontaktné informácie.To je pravdepodobne najdôležitejšia časť dokumentu README.Kontaktné informácie umožnia užívateľovi kontaktovať, aby vám ponúkol na doplnenie programu, položte otázku, opraviť chybu alebo zaplatiť program. Zahrnúť názov spoločnosti, webovú stránku, e-mail a telefónne číslo (tieto informácie budú mať pár reťazcov).

Príklad je zobrazený na obrázku.

Obrázok s názvom Napísať čítanie ma krok 2

2. Vložte dátum v readme.Je to malý, ale veľmi dôležitý krok.Je dôležité určiť dátum distribúcie vášho programu. Užívatelia si uvedomujú aktualizácie verzie programu a budú môcť určiť, či je doteraz podporovaný.

Obrázok s názvom Napíšte čítanie ma krok 3

3. Zaznamenajte názov programu, verzie a cenové informácie.Na poschodí Napíšte názov aplikácie a číslo verzie.Nižšie napíšte cenu za plnú verziu. Ak distribuujete program pomocou fyzických médií, napríklad CD, nemusíte obsahovať informácie o cenách, pretože používatelia pravdepodobne zaplatili za program.

Obrázok s názvom Napíšte si prečítať ma krok 4

4. Stručne opíšte program.V jednom dvoch vetách poskytnite stručný opis vášho programu.Napríklad: "Táto aplikácia monitoruje náladu užívateľa, analyzuje svoju činnosť na internete, po ktorej priestor na pracovnej ploche zmení takým spôsobom, aby sa prispôsobil emocionálny stav užívateľa."

Ak má váš softvér pomerne široký zoznam funkcií, môžete rozšíriť popis na celý odsek alebo dva. Môžete použiť označený zoznam na číslo všetkých funkcií a funkcií programu.

Obrázok s názvom Napíšte si prečítať ma krok 5

päť. Popíšte minimálne požiadavky na program.V dobrom súbore readme musia existovať informácie o minimálnych požiadavkách na pokyny na program a inštaláciu.Ak potrebujete inú časť softvéru na inštaláciu programu, nezabudnite to spomenúť. Môžete tiež zahrnúť informácie o odporúčaných požiadavkách (napríklad na stiahnutie CPU).

Obrázok s názvom Napíšte si prečítať ma Krok 6

6. Povoliť informácie o licencii a autorských právach. Na konci nezabudnite zadať informácie o dátume autorského práva a licenčného programu.

Tipy

Ak chcete, aby ste svoj súbor formátoval, uložte ho do jednoduchého formátu textu (.TXT).
V názve súboru README povoľte názov programu - takže užívateľ vyhľadá súbor ReadMe podľa názvu programu.

Čo potrebuješ

Počítač
Textový editor