Jak i kiedy używać ilustracji, screenshotów i symboli? Dlaczego warto używać elementów wizualnych? Czy wykorzystanie obrazów może zaangażować Waszych odbiorców lub pomóc im utrzymać koncentrację? Jak to wszystko rozsądnie zrobić i o czym warto pamiętać? Na te wszystkie pytania postaramy się odpowiedzieć w tym artykule!
Cofniemy się w nieco w czasie do okresu PRL.
Dokumentacja techniczna powinna być dostępna dla każdego. Ale czy to oznacza, że dokumentacja dla osób, które mają problem z rozróżnianiem kolorów to jest zupełnie inna bajka? Nie do końca!
Jakiś czas temu pisaliśmy o podstawowych zasadach użycia kontrolowanego języka angielskiego (Simplified Technical English). W tym artykule dowiecie się więcej dlaczego i jak go używać.
Ostatnio dużo pisaliśmy o tworzeniu dokumentacji API, wiec teraz dla odmiany napiszemy trochę o tym jak sobie pomóc w tworzeniu dokumentacji maszynowej.