Graphical presentation of the building structure

From HelpSystem
Jump to navigation Jump to search

INSTRUKCJA UŻYCIA WZORCA

tytuł strony - Funkcja / element programu (opis funkcji lub modułu funkcjonalnego będącego elementem //link:szablon zastosowanie//)

Product InstalSystem 4
Type of article Functionality
Content up-to-date for version IS 4.13 NS 4.7

Description

Sekcja na opis funkcjonalności, który powinien uwzględniać:

  • co to jest (funkcja|moduł) i do czego służy,
  • jak działa,
  • typowe zastosowania (nie ma konieczności wymienienia wszystkich zastosowań funkcji, tylko te typowe)

W sekcji można dodać screeny. Powinny one w jednoznaczny sposób przestawiać wybrany element, np. poprzez zaznaczenie elipsą.

Location in the program

Sekcja opisująca sposób użycia funkcji|modułu:

  • w którym miejscu w programie jest dostępna,
  • jak wywołać funkcję (pasek narzędzi, klawisz funkcyjny, itd.).

Example of use - definicja przykładu

Sekcja zawierająca opis użycia funkcji - kolejne kroki.
W ramach tej sekcji może znaleźć się wiele przykładów użycia, każdy z tych przykładów stanowi wtedy osobny podpunkt tej sekcji.
Mogą się w niej znaleźć takie elementy jak:

  • screen (jednoznacznie wskazujący element, np. poprzez zaznaczenie elipsą). Screeny równamy to lewej strony, aby zachować odpowiednie wcięcie poprzedzamy wstawienie screenu znakiem ":".
  • film lub referencja do filmu obrazującego użycie funkcji.

Uwaga! dopuszczalne jest podanie kilku przykładów. Wtedy każdy przykład to osobna sekcja/ lub podpunkt artykułu).