Rzeczywistość współczesnego tech writingu to docs-as-code: Git, Markdown i Static Site Generators (SSG). Jak ma się w tym wszystkim odnaleźć tech writer? Moja odpowiedź brzmi: najlepiej tak, żeby nie stać się programistą.
Umiejętności miękkie są równie ważne jak techniczne, ponieważ to od nich zależy, czy dokumentacja będzie przyjazna w odbiorze i dopasowana do potrzeb użytkownika. W końcu dobra dokumentacja to nie tylko zestaw danych — to most między człowiekiem a technologią!
Reuse wydaje się być Świętym Graalem technical writingu, ale w tym artykule chciałbym pokazać, jak ta popularna praktyka może zepsuć wyniki wyszukiwania.
Czy analogowe notatki mają prawo bytu w dzisiejszym cyfrowym świecie? Uważam, że tak, a przynajmniej "u mnie to działa" 🙂 Zapraszam do zapoznania się z metodą tworzenia notatek wizualnych.
In 2023, the Technical Writing Team at Hitachi Energy in Kraków participated in District C, a project run by the University of North Carolina Wilmington (UNCW) to inspire the next generation of energy professionals. This project was a perfect storm of teamwork, where the Hitachi Energy employees gave the students the glimpses of the day-to-day experiences of documentation developers. The collaboration provided valuable insights into technical writing, cross-cultural teamwork, and continuous improvement, which makes this story a compelling read for those interested in education, design thinking, or professional development.