Jak napsat Readme: 6 kroků

Soubor Readme je malý dokument, který je obvykle připojen k programu.Readme soubory jsou napsány vývojáři softwaru a obsahují základní informace o programu, včetně instalačních dat nebo systémových nastavení, kontaktních informací, licence, vděčnosti a informací o verzi.Distribuovat software, je důležité vědět, jak napsat soubor Readme. Špatně písemný dokument readme může zklamat, pneumatika uživatele, zatímco úspěšná volba mu pomůže s jednoduchostem naučit základní informace o vašem programu.

Kroky

jeden. Povolit kontaktní údaje.To je pravděpodobně nejdůležitější součástí dokumentu Readme.Kontaktní informace umožní uživateli kontaktovat, abyste Vám nabídli doplnění programu, zeptat se na otázku, opravit chybu nebo zaplatit program. Zahrnout název společnosti, webové stránky, e-mail a telefonní číslo (tyto informace budou mít pár řetězců).

Příklad je zobrazen na obrázku.

2. Vložte datum do svého readme.Je to malý, ale velmi důležitý krok.Je důležité určit datum distribuce programu. Uživatelé si proto budou vědomi aktualizací verze programu a budou také schopni určit, zda je dosud podporován.

3. Záznam názvu programu, verzi a cenových informací.Nahoře Napište název aplikace a číslo verze.Níže napište cenu za plnou verzi. Pokud program distribuujete pomocí fyzických médií, například CD, nemusí obsahovat informace o cenách, protože uživatelé pravděpodobně již zaplatí za program.

4. Stručně popište program.V jednom dvou větách uveďte stručný popis svého programu.Například: "Tato aplikace monitoruje náladu uživatele analýzou své činnosti na internetu, po které mění prostor na ploše takovým způsobem, aby upravil emocionální stav uživatele."

Pokud má váš software poměrně široký seznam funkcí, můžete portál rozšířit na celý odstavec nebo dva. Můžete použít označený seznam pro číslo všech funkcí a funkcí programu.

Pět. Popište minimální požadavky programu.V dobrém souboru Readme musí být informace týkající se minimálních požadavků na instrukce programu a instalace.Pokud potřebujete další část softwaru pro instalaci programu, nezapomeňte ji uvést. Můžete také zahrnout informace o doporučených požadavcích (například ke stažení CPU).

6. Povolit licenci a informace o autorských právech. Na konci nezapomeňte zadat informace o datu autorského a licenčního programu.

Tipy

Chcete-li soubor naformátovat, uložte jej v jednoduchém formátu textu (.Txt).
V názvu souboru Readme povolte název programu - takže uživatel vyhledá souboru Readme podle názvu programu.

Co potřebuješ

Počítač
Textový editor