Taking up where from we left off w części 1 z serii narzędzi do pisania technicznego. (Czy sprawdzić, jeśli nie czytałem go)
W tej raty, mamy do czynienia z narzędzi technicznych pisania używane w fazie „Informacje Document”.
To jest pisanie, edycja, rysunek, przegląd i przepisywania fazy. Jest to faza, w której zespół zajmujący się dokumentacją informacji jest w pełni sił i tworzy przewodniki, podręczniki, blogi, dema wideo, strony pomocy online i inne. Biorąc pod uwagę różnorodność zadań w tej fazie, narzędzia do pisania technicznego są również dość zróżnicowane i niezliczone.
Top 17 Technical Writing Software Tools For Documentation in 2020
-
- Whatfix
- MediaWiki
- Adobe Robohelp
.
- Notepad++
- WordPress
- Adobe Photoshop
- Adobe Illustrator
- Microsoft Visio
- Windows Snipping Tool
- Windows Movie Maker
- Powtoon
- Prezi
- Microsoft Word
- Kingsoft WPS Office
- Google Docs
- Adobe Framemaker
- oXygen XML Author
.
1. Whatfix
Whatfix oznacza zmianę paradygmatu w sposobie prezentacji dokumentacji pomocy online. Statyczne i długie strony pomocy internetowej nie przykuwają uwagi użytkownika tak skutecznie, jak interaktywne, obrazkowe przewodniki prezentowane przez Whatfix, popularnie zwane „dymkami”.
Ponadto, pomoc online w dzisiejszym świecie musi rozprzestrzeniać się na różne gadżety – czy to komputery PC, tablety czy smartfony. Whatfix automatycznie dostosowuje treść pomocy do danego gadżetu. A ta sama treść pomocy może być dostępna w różnych formach – jako pokaz slajdów, PDF lub wideo.
Porada autora: Whatfix obsługuje unikalną funkcję – Real-time Interactive walkthrough – w której umieszczasz swoje snippety pomocy bezpośrednio na stronie produktu na żywo! Użytkownik czyta snippet w dymku Whatfix i wykonuje odpowiednią akcję na stronie. Jest to popularne narzędzie do pisania tekstów technicznych wśród firm poszukujących zmiany w stosunku do tradycyjnych metodologii.
MediaWiki
Wyświetlanie pomocy online Twojego produktu jako stron wiki jest prostym i skutecznym pomysłem. Twoje strony mogą być zintegrowane bezpośrednio z Wikipedią, jeśli nie masz osobnej witryny dla swojego produktu online. Alternatywnie można umieścić strony pomocy w formie Wiki na stronie produktu. Kluczową zaletą jest duża znajomość tego formatu wśród użytkowników internetowych, a darmowe narzędzie do edycji wiki, MediaWiki Visual Editor, ułatwia tworzenie pomocy.
MediaWiki to oparte na PHP narzędzie do edycji stron WWW, z którego korzysta Wikipedia. Jednak nawet największe korporacje zajmujące się oprogramowaniem, takie jak Intel, używają tego narzędzia do prezentowania swoich informacji handlowych i marketingowych, How To’s oraz stron pomocy dotyczących polityki i procedur.
Porada autora: To narzędzie do pisania tekstów technicznych jest wyposażone w dobre wsparcie dla rozszerzeń – dla treści w wielu językach, wspólnego przeglądania, śledzenia edycji, wbudowanego wyszukiwania itp.
Adobe RoboHelp
Industry standard authoring tool used to create help systems for desktop or web-based applications. RoboHelp nie jest obcy żadnemu użytkownikowi komputera! Za każdym razem, gdy naciskasz klawisz F1 w dowolnej standardowej aplikacji, okno pomocy, które się pojawia jest prawie zawsze tworzone przy użyciu RoboHelp. Może być również używany do tworzenia konwencjonalnej dokumentacji technicznej do druku, takiej jak przewodniki i instrukcje obsługi.
Wyrafinowane RoboHelp IDE umożliwia pisarzom technicznym tworzenie dużych projektów pomocy i renderowanie ich na wielu urządzeniach/systemach operacyjnych i w wielu formatach (PDF, HTML, DOC, itp.). Starsza wersja RoboHelp może być zakupiona jako tania edycja, jeśli budżet jest ograniczony. Małe firmy mogą jednak korzystać z prostych, darmowych alternatyw, takich jak blogi WordPress lub Wiki. Stary dobry MS Word również może wygenerować podstawowe pliki pomocy HTML dla Ciebie.
Porada autora: Zarządzanie dużymi produktami oprogramowania z regularnymi wersjami aktualizacji może być poważnym wyzwaniem dla pisarzy technicznych, ponieważ muszą oni być zsynchronizowani z historią zmian produktu. Pliki pomocy często pokazują konfigurowalne zmienne zdefiniowane przez użytkownika, które są powtarzane wielokrotnie w całej dokumentacji pomocy. (Na przykład, zmienna taka jak „Czas uśpienia po braku aktywności” jest ustawiona na 30 sekund w poprzedniej wersji, a w aktualizacji ma być ustawiona na 1 minutę). Projekt RoboHelp zająłby się aktualizacją wartości zmiennej w plikach pomocy!
Notepad++
Bardzo skuteczny edytor HTML dla początkujących. Większość ludzi uczy się podstaw programowania HTML na tym narzędziu do pisania technicznego. Jeśli twoje oprogramowanie nie wymaga bardzo ciężkiej dokumentacji pomocy online, do tworzenia plików pomocy o średniej wielkości, to narzędzie jest więcej niż wystarczające.
Jego konfigurowalny GUI pozwala na łatwą edycję, obsługuje WYSIWYG do drukowania, a także posiada opcje obsługi wielu języków.
Porada autora: Notepad++ wyposażony jest w bogaty zestaw pluginów. Multi-clipboard, Code Compare, Auto-Save to tylko niektóre z nich. Pisarze techniczni muszą wybrać odpowiedni zestaw wtyczek, które mogą przekształcić zwykły edytor dla początkujących w realną opcję edycji pomocy online.
WordPress
Miejsce GoTo, jeśli chcesz mieć dokumentację techniczną dla swojego produktu w formie blogów. WordPress jest darmową, otwartoźródłową platformą do zarządzania treścią online. Blogi napisane na WordPressie mogą być dostępne bezpośrednio z adresu URL bloga WordPress lub mogą być zintegrowane z witryną firmową.
Ten artykuł sam jest hostowany na blogu WordPress o nazwie Whatfix Academy. Jeśli celem jest regularne publikowanie treści online na temat firmy/związanych z nią technologii, należy założyć konto blogowe WordPress. Blogi mogą również przechwytywać reakcje użytkowników w postaci komentarzy i polubień, co ułatwia angażowanie się z docelowymi odbiorcami i wyczuwanie ich uznania dla produktu.
Porada autora: Blogi w izolacji mogą nie gromadzić wystarczającej ilości gałek ocznych. Tak więc, napisz swój blog najpierw, promować swój blog na platformach mediów społecznościowych następny i wreszcie zmierzyć oglądalność / odpowiedzi przed podjęciem się z następnym zestawem blogów!
Also Read: How Technical Writing Is Changing With The Times
Adobe Photoshop
Jednym z narzędzi, które większość pisarzy technicznych w całej branży przysięgają. Jest to najpopularniejsze na świecie narzędzie do edycji obrazu, służące do tworzenia i edycji zdjęć oraz dzieł sztuki opartych na rastrze (pikselach). Może być używany do tworzenia projektów interfejsów użytkownika, stron internetowych, banerów reklamowych, grafiki wideo, edycji obrazów do druku. Manipulowanie obrazem, nakładanie jednego obrazu na drugi, udoskonalanie fotografii w celu usunięcia niedoskonałości, korygowanie oświetlenia to jego najpopularniejsze zastosowania. Proces edycji obrazu jest odwracalny i przyrostowy, dzięki czemu zmiany mogą być łatwo cofnięte.
Porada autora: Dla profesjonalnych projektantów, którzy stale potrzebują narzędzia do edycji obrazu, nie ma prawie żadnego zamiennika dla Adobe Photoshop. Jednakże, jeśli jesteś okazjonalnym użytkownikiem, wypróbuj GIMP, który jest programem open source. Obsługuje on tylko schematy kolorów RGB, podczas gdy Photoshop obsługuje również tryb kolorów CMYK (CYAN YELLOW MAGENTA BLACK). A krzywa uczenia się jest wyższa w przypadku GIMP-a, ale jest on darmowy, podczas gdy Photoshop kosztuje bombę!
Adobe Illustrator
Narzędzie do tworzenia i edycji ilustracji wektorowych, takich jak logo i znaki firmowe lub inne elementy projektu. Graficy często popełniają błąd, projektując swoje loga produktów w Photoshopie. Ale to samo logo musi być drukowane na kartach wizytowych, jak również masywne billboardy reklamowe. Tak więc, skalowanie obrazu bez utraty wyrazistości jest tutaj kluczem, który osiągają narzędzia do obrazowania oparte na grafice wektorowej. Adobe Illustrator i Corel Draw są wiodącymi narzędziami do pisania technicznego w tej przestrzeni.
Podpowiedź autora: To narzędzie jest częścią rozwiązania Adobe Creative Cloud z drogimi miesięcznymi opłatami za wynajem. Darmowe alternatywne narzędzia do pisania technicznego, takie jak Inkscape czy Affinity Designer, mogą równie dobrze poradzić sobie z formatami SVG. Jeśli nie potrzebujesz wszystkich głównych narzędzi do pisania technicznego, które są częścią tego rozwiązania (Photoshop, InDesign itp.), to narzędzie nie jest koniecznością.
Microsoft Visio
Popularne narzędzie do diagramowania używane w projektowaniu aplikacji inżynierskich. Autorzy techniczni często muszą projektować diagramy przepływu, schematy architektoniczne, schematy obwodów elektrycznych, projekty produktów programowych i tak dalej. Visio jest wygodną pomocą w tym zakresie.
Jest to zgodne z IEEE narzędzie do pisania technicznego, które jest zgodne ze standardami przemysłu oprogramowania, takimi jak UML (Unified Modeling Language) i BPMN (Business Process Model and Notation).
Podpowiedź autorów: Visio nie był częścią tradycyjnego pakietu Microsoft Office, zawsze był sprzedawany oddzielnie, podobnie jak MS Project. Ale najnowsze ogłoszenie firmy Microsoft mówi, że subskrybenci online pakietu Office 365 mogą teraz uzyskać dostęp do Visio również.
Windows Snipping Tool
Jeśli szukasz opcji przechwytywania ekranu, które są bardziej wyrafinowane niż PrntScr na klawiaturze, Snipping Tool jest dobrym wyborem. Oprócz przechwytywania całego ekranu, możesz również przechwytywać wycinki z wolnej ręki lub wycinki części ekranu. Aby przechwytywać nieruchome obrazy z filmów, użyj opcji opóźnienia, aby dokładna klatka mogła zostać zapisana jako obraz.
Porada dla autorów: Jest częścią pakietu oprogramowania Windows, ale może nie być domyślnie włączona w niektórych edycjach Windows.
Windows Movie Maker
Proste narzędzie do edycji wideo, którego autorzy techniczni mogą używać do tworzenia filmów demonstracyjnych swoich produktów. Jest ono częścią pakietu Windows Essentials. Jednak od stycznia 2017 roku oprogramowanie to zostało wycofane z użytku, bez zapowiedzi odpowiedniego zamiennika. Tak więc, wszyscy ci użytkownicy ze starszymi wersjami systemu Windows, podziękujcie swoim szczęśliwym gwiazdom!
Porada dla autorów: Filmy i wycinki audio można układać i edytować w widoku storyboard, klatka po klatce. Można też rozciągnąć serię nieruchomych obrazów na osi czasu. Głosy audio połączone z dźwiękami tła mogą nadać Twoim filmom wyrafinowaną przewagę.
Powtoon
Piśmiennictwo techniczne staje się coraz bardziej wizualne. Animowane filmy wideo są doskonałym sposobem na przyciągnięcie uwagi użytkownika i przekazanie wiadomości w angażujący sposób. Powtoon to dobre internetowe narzędzie do animacji, sprzedawane jako produkt SaaS. Animowane prezentacje i explainer videos mogą być tworzone za pomocą tego narzędzia za darmo. Jednak filmy stworzone za pomocą darmowej wersji będą miały znak wodny „Powtoon”.
Wskazówka dla autorów: Jeśli pismo techniczne nie jest do celów oficjalnych, to doskonale OK, aby użyć darmowej wersji tego narzędzia. Jednakże, nominalny czynsz, można uzyskać wersję premium, która pozwala na tworzenie filmów bez znaku wodnego i kilka innych funkcji.
Prezi
Niekonwencjonalne podejście do tworzenia demo w formie prezentacji wideo. W przeciwieństwie do Powerpointa, gdzie treść jest sztywno podzielona na slajdy, Prezi daje Ci tylko jedno ogromne puste płótno. Możesz na nim pisać, rysować, jak tylko chcesz. Powiększanie lub pomniejszanie zawartości i przesuwanie ostrości z jednej klatki do drugiej na tym samym płótnie – to sposób na stworzenie ciągłej prezentacji wideo.
Podpowiedź autorów: Oprócz wersji darmowej, istnieje wersja próbna dla studentów, która jest również darmowa, która ma prawie wszystkie funkcje wersji płatnej. Pick that one.
Read Also – 14 Technical Writing Misconceptions That You Should Know!
Microsoft Word
To nie czuje się dość głupio pisać o wszechobecnym MS Word. Ale bez względu na to, jak powszechny jest on w naszym codziennym cyfrowym życiu, nadal jest najlepszym przyjacielem pisarza technicznego! Dzięki łatwej konwersji pomiędzy formatami PDF i DOC, proste połączenie Worda i Adobe Acrobat Reader nie powinno być lekceważone. Ten artykuł może być o wszystkich fantazyjnych narzędzi technicznych pisania na świecie, ale to jest napisane przy użyciu – skromny MS Word!
Autorzy 'Tip: Eksperymentuj z różnymi szablonami dokumentów, które Word ma w ofercie. Pomagają one nadać dokumentowi wygląd odpowiedni do zamierzonego celu – jako ulotki marketingowe, techniczne whitepapers, przewodniki rozwiązywania problemów i tak dalej.
Kingsoft WPS Office
MS Word, PowerPoint i Excel są znane jako najczęściej używane narzędzia oprogramowania do pisania technicznego, wyprzedzając o mile dostępne alternatywy. Tylko rewolucja Android spowolnił MS Office juggernaut trochę. I dał pozycję wybitnych do Kingsoft Office, rozsądne i darmowe alternatywy dla MS Office.
Authors’ Tip: Istnieje kilka zaawansowanych funkcji, których WPS Writer nie obsługuje – tezaurus jest jedną z nich. Tezaurus jest ważną funkcją dla pisarzy technicznych, ponieważ ciągle szukamy lepszych słów, aby wyrazić te same punkty w różnych dokumentach technicznych!
Google Docs
W świecie, który coraz częściej sięga po poręczny telefon komórkowy, aby przeczytać dokumenty, zamiast zadawać sobie trud włączenia komputera, google docs powoli zyskuje na znaczeniu. Tworzenie dokumentów od zera nie będzie wygodne w Google Docs, ale wspólne przeglądanie i edycja mogą być sprawnie przeprowadzone dzięki tej opartej na chmurze alternatywie dla MS Office.
Porada autora: Jego bezproblemowa integracja z Gmailem i Google Drive czyni go jeszcze bardziej atrakcyjnym. Jako pisarz techniczny, będziesz trzymać się zaawansowanych narzędzi do przetwarzania tekstu. Ale twój menedżer produktu, który może być w ciągłym ruchu, najprawdopodobniej nadrobi zaległości w recenzjach na swoim telefonie!
Adobe Framemaker
Wyrafinowany procesor dokumentów dla dużych, standardowych dokumentów przemysłowych. Może być używany do generowania ustrukturyzowanych dokumentów z ramą XML, ze 100% zgodnością z DITA. Może być używany również do dokumentów niestrukturalnych, jako zamiennik edytorów dokumentów takich jak MS Word.
Framemaker jest dobrym wyborem do generowania dokumentów strukturalnych z predefiniowanymi szablonami zgodnymi z kilkoma standardowymi formatami przemysłowymi – takimi jak umowy prawne i sprawozdania finansowe. Obsługuje tworzenie TOC lub indeksu w wielu dokumentach, posiada bogate opcje formatowania. Nie spada wydajność, gdy wstawiana jest grafika.
Porada autora: Framemaker to dobra inwestycja dla firm o ugruntowanej pozycji, posiadających formalne zespoły zajmujące się pisaniem tekstów technicznych, które muszą tworzyć duże dokumenty, liczące ponad 100 stron. Jednak firmy zajmujące się pojedynczymi produktami i startupy nie muszą dokonywać tej inwestycji. Istnieją darmowe narzędzia do tworzenia dokumentów oparte na języku XML. I zawsze można wrócić do starego, dobrego MS Worda!
oXygen XML Author
Jest to darmowy, open source’owy edytor XML zgodny z DITA, mający kilku lojalnych użytkowników i dobre recenzje. DITA (Document Information Typing Architecture) jest otwartym standardem dla tworzenia i publikowania dokumentów, który powoli utorował sobie drogę do zarządzania dokumentami technicznymi. Po prostu dlatego, że usuwa zależność edycji treści od konkretnego narzędzia. Tworzysz dokumentację online zgodną z DITA (zestaw plików XML), a następnie edycja i utrzymanie jej w przyszłości będzie możliwe za pomocą każdego innego narzędzia zgodnego z DITA!
Ponieważ specyfikacja DITA jest obszarem, który wymaga szczególnej uwagi, pozwól mi zachować to na inny artykuł.
Porada autora: Wystarczy powiedzieć, że pakiet narzędzi oXygen jest realną alternatywą dla ogromnie popularnego, ale zaporowo drogiego Adobe Framemakera. oXygen Author jest zazwyczaj używany w połączeniu z oXygen Developer.
Więc, to już wszystkie programy do pisania technicznego, które będą potrzebne w fazie „Informacje o dokumencie”. W następnej i ostatniej części przedstawimy fazę „Publikowanie informacji”.
Aby poznać kilka świetnych wskazówek dotyczących pisania technicznego i upewnić się, że nie przegapisz naszych aktualizacji narzędzi do pisania technicznego, zapisz się na nasz blog.
Podobało Ci się? Zapisz artykuł do zakładek lub podziel się nim ze swoimi przyjaciółmi i kolegami!
W Whatfix, wprowadzamy innowacje w przestrzeni narzędzi do pisania technicznego, przerywając samą ideę długich, ciągłych treści pisanych. Nasze interaktywne przewodniki pomogą Ci stać się bardziej produktywnym, zapewniając szybki i skuteczny sposób tworzenia dokumentacji technicznej. Przeczytaj więcej o tym, jak Whatfix pomaga w pisaniu dokumentacji technicznej w tym artykule.
.