Nie wahaj się proponować zmian. Możesz komentować, uzupełniać, redagować każdy fragment dokumentu.
Standard przygotowania dokumentów tekstowych
1. Cel standardu
Standard określa zasady przygotowania dokumentów tekstowych w sposób zapewniający:
- dostępnośćdostępnośćZakres, w jakim produkty, systemy, usługi, środowiska i obiekty mogą być używane przez ludzi z populacji o najszerszym zakresie cech i możliwości, aby osiągnąć określony cel w określonym kontekście użytkowania (ISO TC 159). Właściwość środowiska (przestrzeni fizycznej, rzeczywistości cyfrowej, systemów informacyjno-komunikacyjnych, produktów, usług), która pozwala osobom z trudnościami funkcjonalnymi (fizycznymi, poznawczymi) na korzystanie z niego na zasadzie równości z innymi. cyfrową,
- możliwość odczytu przez technologie wspomagające,
- czytelność i zrozumiałośćzrozumiałośćWłaściwość strony internetowej lub aplikacji mobilnej umożliwiającą użytkownikowi tych stron i aplikacji zrozumienie treści i sposobu ich prezentacji. treści,
- poprawną strukturę dokumentu,
- możliwość dalszego przetwarzania i publikacji dokumentów.
Standard wspiera organizację procesów przygotowania i publikacji dokumentów cyfrowych oraz realizację wymagań dostępności cyfrowej.
Standard łączy wymagania dostępności cyfrowej z zasadami jakości i organizacji pracy. Jeżeli dane postanowienie wynika z WCAG, normy lub przepisu prawa, ocenia się je według właściwego wymagania. Pozostałe wskazówki wspierają czytelność, zrozumiałość i spójność materiałów, ale nie zastępują ani nie zmieniają wymagań normatywnych.
2. Zakres stosowania
Standard stosuje się do dokumentów tekstowych przygotowywanych lub publikowanych przez organizację, w szczególności:
- pism,
- komunikatów,
- instrukcji,
- raportów,
- analiz,
- procedur,
- regulaminów,
- informacji publikowanych w formatach DOCX, ODT lub równoważnych,
- dokumentów przeznaczonych do eksportu do PDF.
Standard ma zastosowanie niezależnie od:
- sposobu publikacji dokumentu,
- kanału udostępnienia,
- wykorzystywanego oprogramowania biurowego.
3. Zasady ogólne
Dokument tekstowy powinien być przygotowywany w sposób umożliwiający:
- odczyt przez technologie wspomagające,
- nawigację po strukturze dokumentu,
- zmianę sposobu prezentacji treści przez użytkownika,
- poprawny eksport do innych formatów.
Dostępność dokumentu powinna być uwzględniana na etapie jego tworzenia.
Niedopuszczalne jest przygotowywanie dokumentów:
- wyłącznie w postaci obrazu,
- bez struktury logicznej,
- w sposób uniemożliwiający interpretację treści przez technologie wspomagające.
4. Struktura dokumentu
Dokument powinien mieć logiczną strukturę.
W szczególności należy:
- stosować tytuł dokumentu,
- stosować nagłówki odpowiadające strukturze treści,
- zachowywać logiczną kolejność sekcji,
- dzielić treść na akapity i części tematyczne.
Nagłówki powinny:
- odzwierciedlać hierarchię informacji,
- być stosowane w odpowiedniej kolejności,
- wspierać nawigację po dokumencie.
Nie należy:
- tworzyć struktury wyłącznie poprzez zmianę wyglądu tekstu,
- pomijać poziomów nagłówków,
- stosować przypadkowej hierarchii sekcji.
5. Style i formatowanie
Formatowanie dokumentu powinno opierać się na stylach wbudowanych lub szablonach dokumentu.
W szczególności należy:
- stosować style nagłówków,
- stosować style akapitów,
- zachowywać spójność formatowania,
- wykorzystywać mechanizmy strukturalne oprogramowania.
Nie należy:
- formatować struktury ręcznie,
- tworzyć odstępów za pomocą wielu spacji lub pustych akapitów,
- stosować tabulatorów do budowania układu dokumentu,
- używać wielu różnych sposobów formatowania tego samego typu treści.
6. Język i czytelność treści
Treść dokumentu powinna być:
- jednoznaczna,
- uporządkowana,
- zrozumiała,
- dostosowana do odbiorców.
W szczególności należy:
- stosować prosty językprosty językSposób tworzenia treści, który ułatwia szybkie zrozumienie komunikatu. Obejmuje krótkie zdania, jasną strukturę, znane słowa, wyjaśnianie skrótów i unikanie niepotrzebnego żargonu.,
- używać krótkich zdań,
- wyjaśniać pojęcia specjalistyczne — jeżeli są konieczne,
- unikać nadmiernie złożonych konstrukcji.
Treść powinna umożliwiać szybkie odnalezienie najważniejszych informacji.
7. Listy i elementy strukturalne
Listy powinny być tworzone z wykorzystaniem mechanizmów list numerowanych lub punktowanych.
Należy:
- stosować listy numerowane dla sekwencji działań,
- stosować listy punktowane dla zestawień,
- zachowywać logiczną strukturę list.
Nie należy:
- tworzyć list ręcznie przy użyciu znaków specjalnych,
- budować struktury dokumentu wyłącznie za pomocą wcięć.
8. Tabele
Tabele należy wykorzystywać wyłącznie do prezentacji danych.
W szczególności należy:
- stosować nagłówki tabel,
- zachowywać logiczną strukturę danych,
- unikać scalania komórek utrudniającego interpretację,
- stosować prostą strukturę tabel.
Nie należy:
- wykorzystywać tabel do układu wizualnego dokumentu,
- tworzyć nadmiernie rozbudowanych lub wielopoziomowych tabel bez uzasadnienia.
Tabela powinna być możliwa do interpretacji przez technologie wspomagające.
9. Grafiki i materiały wizualne
Grafiki umieszczane w dokumencie powinny:
- mieć opisy alternatywne,
- wspierać przekaz treści,
- nie być jedynym źródłem kluczowych informacji.
Grafiki przekazujące informacje powinny mieć odpowiednie opisy alternatywne.
Opis alternatywny powinien:
- przekazywać znaczenie grafiki,
- uwzględniać kontekst dokumentu,
- umożliwiać zrozumienie informacji bez dostępu do obrazu.
Wykresy, diagramy i infografiki powinny mieć równoważną formę tekstową umożliwiającą odbiór przekazywanych informacji bez konieczności interpretowania grafiki.
10. Linki i odwołania
Linki powinny:
- jasno wskazywać cel odnośnika,
- być zrozumiałe poza kontekstem akapitu,
- prowadzić do zasobów zgodnych z wymaganiami dostępności — jeżeli organizacjaorganizacjaGrupa ludzi, instytucja lub państwo, które działają razem, by osiągnąć wspólne cele, posiadając ustaloną strukturę. Zobacz także: podmiot publiczny ma wpływ na ich przygotowanie.
Należy unikać:
- ogólnych sformułowań typu „kliknij tutaj”,
- publikowania nieopisanych adresów URL jako głównej treści linku.
11. Czytelność wizualna
Dokument powinien zapewniać odpowiednią czytelność.
W szczególności należy:
- zapewniać kontrastkontrastRóżnica jasności między tekstem lub elementem graficznym a tłem. Odpowiedni kontrast ułatwia odczyt osobom słabowidzącym, użytkownikom urządzeń mobilnych i osobom korzystającym z treści w trudnych warunkach oświetleniowych. zgodny z właściwymi wymaganiami WCAG, jeżeli mają zastosowanie,
- stosować czytelne kroje pisma,
- zachowywać odpowiednie odstępy między akapitami i liniami,
- ograniczać nadmierne wyróżnianie tekstu.
Nie należy:
- przekazywać informacji wyłącznie kolorem,
- stosować nadmiernie dekoracyjnych elementów,
- publikować dokumentów utrudniających odczyt na urządzeniach mobilnych.
12. Metadane i właściwości dokumentu
Dokument powinien mieć:
- tytuł,
- określony język dokumentu,
- właściwe metadanemetadaneInformacje opisujące zasób, w szczególności jego tytuł, właściciela, daty, wersję, lokalizację, status, podstawę publikacji, relacje z innymi zasobami i sposób dalszego postępowania. — jeżeli są wykorzystywane.
W przypadku dokumentów wielojęzycznych należy oznaczać zmiany języka w treści dokumentu.
13. Eksport i publikacja dokumentu
Dokument powinien być przygotowany w sposób umożliwiający poprawny eksport do innych formatów, w szczególności PDF.
Eksport dokumentu nie powinien prowadzić do utraty:
- struktury,
- opisów alternatywnych,
- znaczników dostępności,
- logicznej kolejności treści.
14. Weryfikacja przed publikacją
Przed publikacją należy sprawdzić, czy dokument spełnia wymagania określone w standardzie.
15. Postanowienia końcowe
Standard stanowi element systemu zarządzania dokumentami cyfrowymi i komunikacją cyfrową organizacji.
Standard powinien być:
- stosowany przy tworzeniu dokumentów tekstowych,
- uwzględniany w działaniach szkoleniowych,
- wykorzystywany przy opracowywaniu szablonów dokumentów.
Stosowanie standardu wspiera dostępność cyfrową, jakość dokumentów oraz równy dostęp użytkowników do informacji publikowanych przez organizację.