Manual
(Różnice między wersjami)
(→Manual i Readme) |
(→Manual i Readme) |
||
| Linia 10: | Linia 10: | ||
** wymagania sprzętowe typu procesor, ram i miejsce na dysku | ** wymagania sprzętowe typu procesor, ram i miejsce na dysku | ||
**wymagania programowe - system operacyjny, dodatkowe programy i biblioteki | **wymagania programowe - system operacyjny, dodatkowe programy i biblioteki | ||
| − | *proces instalacji podstawowej (często minimalnej) | + | *proces [[instalacja|instalacji] podstawowej (często minimalnej) |
*informacje o konfiguracji aby lepiej dopasować program do potrzeb użytkowników | *informacje o konfiguracji aby lepiej dopasować program do potrzeb użytkowników | ||
**opis parametrów startowych | **opis parametrów startowych | ||
Wersja z 10:32, 4 cze 2006
Manual i Readme
Są to instrukcje i dokumentacje o programie/projekcie. Najczęściej są w formacie pliku .txt, .doc, .html, .pdf, (bardzo często pod linuksem są to pliki .txt ale bez rozszerzeń pisane za to wielkimi literami, jak README )
Najczęściej są w katalogu doc/ albo docs/ czy manual/
Zawierają najczęściej w języku angielskim:
- informacje o projekcie (do czego służy)
- wymagania do uruchomienia projektu (programu)
- wymagania sprzętowe typu procesor, ram i miejsce na dysku
- wymagania programowe - system operacyjny, dodatkowe programy i biblioteki
- proces [[instalacja|instalacji] podstawowej (często minimalnej)
- informacje o konfiguracji aby lepiej dopasować program do potrzeb użytkowników
- opis parametrów startowych
- opis plików konfiguracyjnych
- przykładowe konfiguracje
- informacje o metodach aktualizacji programu
- informacje o dodatkach do programu, poszerzających jego możliwości (np pluginy, moduły itp)
- info o oficjalniej stronie projektu/forum i miejsc gdzie można szukać pomocy jeśli instrukcja nie pomaga.
- info o licencji
- autorach
- sprawach związanych z prawami autorskimi i legalnością oprogramowania
- warunki gwarancji i pomocy
- dane o zmianach w poszczególnych wersjach (changelog)
