Kategoria:Dobre praktyki

Dobra dokumentacja – cechy i etapy tworzenia

Dla jednych pisanie dokumentacji to droga przez mękę, dla innych czysta przyjemność i sposób zarabiania na życie. Jednak zarówno ci pierwsi jak i drudzy powinni trzymać się pewnych reguł. Dziś pierwszy z cyklu artykułów, które, mamy nadzieję, pomogą Wam utrzymać jak najwyższy poziom tekstów, a także sprawią, że pisanie nie będzie już takie straszne (dla…




Diagramy generowane z plików DITA? Tak! I nie tylko…

W DITA można pisać treść z multimediami a potem generować z niej HMTLe, PDFy i tak dalej. A co, gdybyśmy chcieli na przykład wygenerować diagram z drzewa procedur? Na szczęście się da….




Wszystko o DITA – Narzędzia (4)

W sieci można natknąć się na całkiem sporo materiałów dotyczących DITA, jednak znalezienie czegoś w języku polskim jest dość trudne. Chcąc zmienić ten stan rzeczy, postanowiliśmy stworzyć dla Was niniejsze kompendium wiedzy o tym standardzie. W tym artykule pytanie „Czym?” przoduje nad pozostałymi, ważkimi pytaniami natury egzystencjalno – dokumentacyjnej. Oczywiście na pytanie „Jak?” również staramy się…




Siedem zasad projektowania pomocy dla użytkownika w 2017 roku

Dziś na naszych łamach gościnny wpis przygotowany przez Matthew Ellisona. Matthew jest organizatorem corocznej konferencji UA Europe, której jesteśmy patronem medialnym. W tym artykule, napisanym specjalnie dla techwriter.pl, Matthew prezentuje siedem zasad tworzenia efektywnej pomocy dla użytkownika. Zachęcamy do lektury i do rozważenia – może zechcecie wybrać się na tę konferencję? Do zobaczenia w Harrogate!…




zdjęcie człowieka skaczącego do wody

DITA conkeyref – Pracuj sprytnie a nie ciężko

Pisaliśmy już o podstawach i tworzeniu strategii dla DITA. Po tym łagodnym wprowadzeniu, postanowiliśmy Was rzucić na głęboką wodę, czyli zająć się zagadnieniem conkeyref. Dzięki temu zapoznacie się z koncepcją kluczy i pobierania treści w dicie. Dla ułatwienia posłużymy się praktycznym przykładem, który mamy nadzieję pozwoli Wam szybko zrozumieć o co w tym wszystkim chodzi….




Naucz się sam(a) – część 7

W dzisiejszym odcinku naszej serii, prezentującej materiały do poszerzania wiedzy z zakresu tech commu, mamy nie lada gratkę dla elektronicznych moli książkowych. Szykujcie czytniki, laptopy i telefony, bo będziecie mieli nad czym spędzić wolny czas….




Wszystko o DITA – Strategia (3)

W sieci można natknąć się na całkiem sporo materiałów dotyczących DITA, jednak znalezienie czegoś w języku polskim jest dość trudne. Chcąc zmienić ten stan rzeczy, postanowiliśmy stworzyć dla Was niniejsze kompendium wiedzy o tym standardzie. Jeżeli zabierasz się właśnie do pracy w tym standardzie, w jednej ręce dzierżysz edytor, w drugiej CMSa, a w głowie…




Wszystko o DITA – Podstawy (2)

W sieci można natknąć się na całkiem sporo materiałów dotyczących DITA, jednak znalezienie czegoś w języku polskim jest dość trudne. Chcąc zmienić ten stan rzeczy, postanowiliśmy stworzyć dla Was niniejsze kompendium wiedzy o tym standardzie. Pierwszy artykuł z tej serii uchylił rąbka ditowej tajemnicy. W tym odcinku znajdziecie pogłębione informacje o języku znaczników wykorzystywanym w…




Technical Writer – człowiek renesansu

Ludzie dzielą się na tych, którzy są Tech Writerami i na tych, którzy nimi nie są. Proste. Tą drugą, liczniejszą grupę możemy z kolei podzielić na tych, którzy nie wiedzą czym się zajmuje Tech Writer i na tych, którym się wydaje, że wiedzą….




CV – najważniejszy dokument Tech Writera

CV Tech Writera to coś więcej niż tylko zestaw informacji o wykształceniu, doświadczeniu zawodowym i posiadanych umiejętnościach – to dla potencjalnego pracodawcy nasz pierwszy dokument z jakim ma styczność. Dlatego też, poprzeczka ustawiona jest zdecydowanie wyżej jeśli chodzi o jakość i formę prezentowanych informacji niż w przypadku stanowisk niezwiązanych z tworzeniem materiałów, które mają pomagać…