Poniższy szablon należy odpowiednio uzupełnić.
- Układ należy zachować (z dopuszczeniem minimalnych modyfikacji).
- Opis nie powinien przekraczać 10 stron przeciętnego ekranu laptopa.
- W razie potrzeby należy założyć podstrony (na końcu z rozdziałem "Co dalej?" i odnośnikiem do kolejnego rozdziału dokumentacji).
- Język opisu - polski. W sytuacji, gdy zasadnicza dokumentacja usługi ma być po angielsku, w tym rozdziale powinny znaleźć się podstawowe informacje pozwalające zorientować się w zaletach usługi i zgrubnie w wymaganych krokach do jej uruchomienia.
- Uprawnienia do odczytu strony (Tools/Restrictions) mogą byś ustawione na "Confluence-users" w pisania dokumentacji, inaczej będzie widoczna od razu dla osób niezalogowanych.
- Pytania dotyczące systemu dokumentacji: Hubert Siejkowski,
- Pytania dotyczące Podręcznika Użytkownika: Unknown User (plgfilocha).
Pomoc w pisaniu stron w Confluence: https://confluence.atlassian.com/display/DOC/Using+the+Editor
Krótki opis usługi
Dla kogo jest przeznaczona, jakie najważniejsze możliwości oferuje?
Aktywowanie usługi
Co należy aktywować, aby móc skorzystać z usługi? (Założenie konta, certyfikat, grant?, aktywacja konkretnych usług w portalu). Należy pamiętać o istnieniu rozdziałów ogólnych podręcznika, do których warto się odwołać.
Ograniczenia w korzystaniu (podsekcja opcjonalna)
Tutaj wpisujemy specjalne zasady korzystania z usługi jeśli takowe są np. konieczność ustawienia grantu domyślnego, zakaz uruchamiania intensywnych zadań na UI itp. Jeśli takowych nie ma to należy tę podsekcję usunąć.
Pierwsze kroki
Koniecznie z przykładowymi zrzutami ekranu lub fragmentami kodu.
Zaawansowane użycie
Ewentualnie jako osobny podrozdział.
Gdzie szukać dalszych informacji?
Strony zewnętrzne (jeśli są), odnośnik do helpdesku lub strony dokumentacji o pomocy.
Można też dodać sekcję "Co dalej?" ze wskazaniem (odnośnikiem) do dalszej części dokumentacji, o ile jest wymagana.
Overview
Content Tools