Co prawda do października jeszcze sporo czasu, ale już teraz informujemy Was, że rusza wtedy kolejna edycja cyklu wirtualnych spotkań związanych z dokumentacją API i doświadczeniami w pracy programisty. Szczegóły poniżej.
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!
Wszyscy jesteśmy zajęci i często nie chcemy tracić czasu na zrozumienie trudnych, rozwlekłych dokumentów. Analizy różnych tekstów potwierdziły, że nietypowe słowa i długość zdań, były jedną z pierwszych przyczyn trudności w czytaniu i rozumieniu tekstu. Wiemy, że w prostym języku (ang. plain language) ważne są - budowa zdań i dobór słownictwa, o czym pisaliśmy już w naszych poprzednich artykułach tutaj i tutaj. Pisanie prostym językiem może zatem oszczędzić nam czas i pieniądze. Pomoże nam również zastosować przekazane informacje oraz ocalić drzewa 😊. Co jeszcze możemy zyskać dzięki korzystaniu z dobrodziejstw prostego języka?