Dokumentacja, pomoc programu

Powrót do: Teaching – Podstawy redakcji cyfrowej

Przykładowy program do tworzenia dokumentacji i pomocy programów: HelpNDoc.

Kilka krótkich komentarzy nt. wybranych aspektów tworzenia dokumentacji i dokumentowania pracy: slajdy.

Ćwiczenia:

1. Proszę pobrać program i uruchomić program HelpNDoc, utworzyć w nim nowy projekt (File -> New Project).

2. Proszę uzupełnić dane o projekcie, nadając mu dowolny tytuł oraz własne imię i nazwisko w polu Autor (formularz widoczny przy tworzeniu nowego projektu, a także po kliknięciu na “Title of this help project”).

3. Proszę dodać nowy temat pomocy i nadać mu nowy, dowolny tytuł. Spróbujmy wykorzystać tematy z zajęć Analiza Języka Mówionego (lub innych zajęć z wykorzystaniem oprogramowania / aparatury) i napisać kilka zdań mini instrukcji odnoszącej się do tej tematyki / narzędzi / procedur 🙂

3. Proszę wygenerować plik pomocy w formacie PDF (Generate Help).

RedTekstow_HelpNDoc

Zaliczenie bloku:

Proszę przesłać wynik ćwiczenia we wskazanym terminie w prywatnej wiadomości czat, przez Teams UAM.

Ćwiczenie 2:

  1. Proszę wybrać temat/narzędzie/proces z obszaru lingwistyki komputerowej, który Państwa zaintrygował, zaskoczył.
  2. Proszę stworzyć nowy dokument w HelpNDoc, zawierający co najmniej 3 sekcje na ten temat (glosariusz, plik pomocy objaśniający wybrane opcje).
  3. Dodaj elementy interaktywne: spis treści, wewnętrzne linki (np. „zobacz także”) oraz indeks.
  4. Zadbaj o estetykę i spójność formatowania.
  5. Wyeksportuj dokument w dwóch formatach: PDF i HTML.

Zaliczenie bloku:

  1. PDF proszę umieścić na Padlecie tutaj https://padlet.com/klessauam/dokumentacja-techniczna-won02mouec50jx07, by inni mogli go obejrzeć.
  2. Plik HTML proszę przesłać do prowadzącej przez czat w Teams.

Comments are closed.