Czytanie dokumentacji technicznej offline na iPadzie

Większość narzędzi do dokumentacji eksportuje statyczny HTML. MkDocs, Sphinx, Docusaurus, Hugo, wygenerowana dokumentacja API: efektem jest samodzielny folder, zaprojektowany do działania bez połączenia. Dokładnie to jest ci potrzebne w samolocie, w piwnicy centrum danych albo u klienta, którego wifi odrzuca twojego laptopa.

Pozostaje otworzyć go na tablecie, który zabrałeś.

Dlaczego PDF nie jest odpowiedzią

Odruchem jest wyeksportowanie dokumentacji do PDF. To działa i przy krótkim dokumencie często jest właściwym wyborem. Ale dokumentacja techniczna dużo traci na konwersji.

• Znika nawigacja boczna, zastąpiona przewijaniem kilkuset stron.
• Odnośniki między sekcjami stają się w najlepszym razie odsyłaczami do stron, w najgorszym martwym tekstem.
• Kolorowanie składni i zwijane bloki kodu nie zawsze przetrwają.
• Każda aktualizacja wymusza ponowny eksport.

Tymczasem eksport HTML już istnieje i zawiera to wszystko.

Zachować dokumentację taką, jaka została wygenerowana

Pagira otwiera folder eksportu tak, jak zrobiłaby to przeglądarka: pasek boczny, odnośniki między stronami, kolorowanie kodu. Korzystasz z dokumentacji, a nie z jej fotografii.

1. Skopiuj folder eksportu do Plików albo do iCloud Drive.
2. Otwórz go w Pagirze.
3. Poruszaj się jak po stronie: pasek narzędzi daje wstecz, dalej i odśwież.

iCloud Drive i kwestia trybu offline

Wygenerowana dokumentacja waży często kilkaset megabajtów, wraz z obrazami i czcionkami. Umieszczona w iCloud Drive, pobiera się w trakcie czytania, bez czekania przed pojawieniem się pierwszej strony.

Przed wyjazdem pobierz trwałą kopię offline. Pobieranie można wznowić, więc zerwane połączenie nie zaczyna od nowa, a baner jasno pokazuje, co pozostaje dostępne bez sieci. Zobacz strumieniowanie z iCloud Drive albo kopię offline.

Przygotować strony, których będziesz potrzebować

Jest offline, który cię zaskakuje, i offline przygotowany. Jeśli już wiesz, z których sekcji skorzystasz, zapisz je na liście do przeczytania przed wyjazdem. Każdy element jest przechowywany jako pełna migawka, a nie zakładka, więc pozostaje czytelny nawet gdy folder źródłowy się przesunie. Zobacz listę do przeczytania.

Przypadek dokumentacji mieszanej

Dokumentacja firmowa niemal zawsze miesza strony HTML i pliki PDF: specyfikację, schemat architektury, załącznik umowny. Jedno i drugie otwiera się w tej samej aplikacji, a odnośnik ze strony do PDF otwiera się na miejscu.

Najczęstsze pytania

A dokumentacja ważąca kilka gigabajtów?

Strumieniowanie z iCloud pozwala uniknąć pobierania wszystkiego naraz. Przy pełnym trybie offline granicą jest miejsce dostępne na urządzeniu.

Moja dokumentacja jest poufna

Nic nie jest wysyłane. Wszystko renderuje się lokalnie, co jest właśnie argumentem wobec usługi online do wyświetlania dokumentów.

Czy mogę czytać ją także na iPhonie?

Tak, jedna aplikacja obsługuje oba, a ostatnie elementy pozwalają wrócić do dokumentu zaczętego na drugim urządzeniu.

Jak otworzyć ją z innego narzędzia?

Przez menu udostępniania, poleceniem Otwórz w Pagirze, z Plików albo z dowolnej aplikacji. Zobacz otwieranie zewsząd.