Tag: Manuale

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….




Wszystko o DITA – strategia

Strategia dla treści (ang. content strategy) odnosi się do tworzenia treści, jej publikacji oraz utrzymania. Jeżeli chcecie dowiedzieć się więcej, możecie sięgnąć do naszego artykułu, który omawia ten temat. Niedawno opisaliśmy podstawowe zagadnienia związane z ditą (dla przypomnienia, przyjęliśmy konwencję, że kiedy odmieniamy skrót DITA piszemy go jakby był słowem). Te podstawy pomogą nam w…




Wszystko o DITA – podstawy

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 swego rodzaju kompendium wiedzy o tym standardzie. Sporym bodźcem był dla nas artykuł opowiadający krótką historię o przygodzie z ditą (przyjęlismy konwencję, że kiedy odmieniamy skrót DITA, piszemy…




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ą….




Nowości w narzędziach typu HAT

Bieżący rok przyniósł nowe wersje dwóch popularnych narzędzi do tworzenia dokumentacji. Przyjrzyjmy się co ciekawego kryje się pod nowymi „numerkami”….




Documentor – opis narzędzia

Podczas szkolenia ITCQF (relacja) spotkaliśmy Adriana, który pracuje z narzędziem Documentor. Po krótkich namowach zgodził się opisać dla Was narzędzie do intuicyjnego i przejrzystego tworzenia dokumentacji z wykorzystaniem WordPress’a – dziękujemy!…




Zaklinacz WordPressa

Helpinator to nie żaden krewny Akinatora, tylko kolejny HAT. Dlatego też nie potrafi zaklinać umysłów, ale za to udało mu się poskromić WordPressa….




Pisanie dokumentów jest jak sortowanie wypranych ubrań

Umiecie odpowiednio posortować wyprane ubrania? Jeśli tak, to prawdopodobnie umiecie też pisać dokumentację. Brzmi dość dziwnie, jednak okazuje się, że te dwa procesy mogą mieć ze sobą wiele wspólnego….




Jak sobie radzić z recenzją merytoryczną dokumentacji?

Dokumentacja, która jest dokładna pod względem merytorycznym to sprawdzone źródło informacji o produkcie, które podnosi wiarygodność Twojej firmy. Nieaktualne informacje mogą wpłynąć niekorzystnie na tempo rozwoju produktu oraz na klientów, którzy nie będą w stanie rozwiązać swoich problemów sięgając po dokumentację. Nieścisłości napotkane w dokumentacji wydłużają również czas potrzebny do opanowania produktu….




Dekalog Tech Writera

Tom Johnson jakiś czas temu pokusił się o stworzenie listy dziesięciu zasad, których według niego powinniśmy się trzymać kiedy tworzymy dokumentację. Poniżej prezentujemy streszczenie tego dekalogu oraz nasze krótkie przemyślenia na jego temat. Oryginalny artykuł dostępny jest tutaj….