Inspiracje dla technical writera - narzędzia

Dziś tematem tekstu będą narzędzia, na które warto zwrócić uwagę tworząc dokumentację.

Narzędzia, z których korzysta technical writer można podzielić na kilka grup, w zależności od ich przeznaczenia. Poniżej przedstawiamy listę różnych narzędzi, których używamy lub z innych powodów uznaliśmy za warte uwagi.

Tworzenie i porównywanie treści

ClickHelp - to nowoczesne narzędzie do tworzenia dokumentacji. Jest niezwykle popularne w firmach z branży IT. Można w nim stworzyć: podręczniki użytkownika, bazy wiedzy, pliki pomocy, FAQ, czy samouczki. Narzędzie to pozwala na natychmiastowe opublikowanie potrzebnych materiałów na własnym portalu. ClickHelp jest łatwy w konfiguracji i obsłudze - nie wymaga instalacji, działa w przeglądarce internetowej i obsługuje wiele platform: Mac OS, Windows i Linux. Pozwala na tworzenie dokumentacji z dowolnego miejsca na świecie. Można go spokojnie używać także w dużych projektach dzięki licznym, zaawansowanym funkcjom. W łatwy i szybki sposób można importować treści z Microsoft Word, HTML, RTF, CHM, ODT itp. i eksportować je do CHM, pomocy HTML5 Web Help, PDF, DOCX itp.. ClickHelp ma własne opatentowane wyszukiwanie pełnotekstowe, które ułatwia znajdowanie tematów, obsługuje symbole wieloznaczne, a także umożliwia wykluczenie określonych tematów z wyników wyszukiwania pełnotekstowego. Popularny wynik wyszukiwania może zostać wyświetlony jako fragment z odpowiedzią, aby szybciej dostarczyć informacje. ClickHelp dysponuje wewnętrznymi narzędziami analitycznymi, które pomogą mierzyć wydajności zespołu i analizować statystyki zachowań użytkowników końcowych. Dzięki dużej gamie funkcji ClickHelp pozwala na pełną kontrolę nad tworzoną dokumentacją. Jest to zdecydowany faworyt wśród narzędzi, z których można korzystać online. Należy wspomnieć, że ClickHelp jest narzędziem komercyjnym, wymagającym opłacenia abonamentu.

Diffchecker - to niezwykle proste narzędzie, dzięki któremu porównasz ze sobą teksty. Wystarczy wpisać zawartość dwóch plików i kliknąć Znajdź różnicę - to wszystko. Narzędzie może porównywać nie tylko teksty, ale także obrazy i pliki PDF. Dzięki niemu oszczędza się sporo czasu i wysiłku. Dodatkowo, ma się większą pewność, że coś nie zostało pominięte. Podobnie jak poprzednik, dostęp wymaga opłacenia abonamentu.

Oprawa graficzna dokumentacji

Na tym polu wybór narzędzi jest przeogromny i każdy użytkownik musi kierować się własnymi potrzebami i upodobaniami. Spośród ogromu opcji wybrałam kilka, które uznałam za najciekawsze.

Snagit - o tym narzędziu napisał bardzo wyczerpująco nasz kolega z zespołu, dlatego, jeśli interesują Was szczegóły zapraszam tutaj i tutaj. Ten, z pozoru niepozorny program, po bliższym poznaniu okazuje się niezwykle funkcjonalny i przydatny. Warto zwrócić na niego uwagę zwłaszcza, gdy tworzona dokumentacja ma zawierać liczne zrzuty ekranu.

GIMP - jeśli Twoja dokumentacja wymaga wielu zdjęć, które z kolei wcześniej trzeba do niej dostosować to GIMP świetnie się do tego nada. Jest to darmowe narzędzie open-source, które stanowi dobrą alternatywę dla Photoshopa. Jest intuicyjny i oferuje wszystkie najpopularniejsze funkcje edytorów graficznych, co sprawia, że to dobre narzędzie dla osób początkujących. Dodatkowo jego interfejs jest bardzo przejrzysty i dobrze zorganizowany, co ułatwia pracę.

Lucidchart - to proste i wygodne narzędzie do tworzenia diagramów. Aby z niego korzystać, wystarczy tylko komputer z przeglądarką internetową. Jednak, jeśli nie masz połączenia z siecią, możesz skorzystać z trybu offline, co jest sporym atutem tego programu. Ma on zarówno wersję bezpłatną, jak i płatną. Oba posiadają liczne szablony, które są bardzo pomocne. Dużym jego plusem jest prostota obsługi, dzięki czemu nie potrzeba wiele czasu by go opanować.

OBS Studio - to narzędzie, które można wykorzystać do tworzenia screencastów do dokumentacji oprogramowania. Można nim nie tylko nagrywać filmy, ale także je edytować. W rzeczywistości ten rejestrator ekranu ma wszystko, czego potrzeba do tworzenia profesjonalnych treści. Jego minusem jest fakt, że wymaga trochę czasu, by nauczyć się jego obsługi i funkcji, z których warto korzystać.

Planowanie procesu twórczego

Notion - to program dla tych, którzy przywiązują dużą wagę do planowania. To niesamowite narzędzie do organizowania czasu, pracy i notatek. Jest przeznaczony zarówno dla firm, jak i osób prywatnych. Warto używać go do tworzenia notatek, gromadzenia kontaktów, przygotowywania pytań, gromadzenia danych referencyjnych itp. Pozwala on efektywnie organizować czas, planować kolejne działania i pracę.

Spośród wielu pomocy dostępnych na rynku wybrałam te, które przypadły mi najbardziej do gustu. Może i Wam się spodobają? A może już z nich korzystacie? Czy do mojej listy warto dodać coś jeszcze? Zapraszam do dyskusji w komentarzach.