Dostopnost dokumentacije

Vprašanje: Kako se dokumentacija prilagaja različnim uporabnikom?

Opis

Dostopnost dokumentacije je ključnega pomena zaradi vloge, ki jo ima dokumentacija v odprtokodnih projektih. Uporabniki dokumentacije imajo različne zmožnosti, kar zahteva, da je dokumentacija ponujena v različnih formatih, da bo enako opolnomočila te različne uporabnike. Cilj je spodbuditi razumevanje najširšega kroga sodelujočih pri projektu.

Cilji

Ti cilji pomagajo izmeriti, ali je vaša dokumentacija dostopna široki publiki brez nesorazmernega ustvarjanja ali ohranjanja umetnih dolgov pri določenih segmentih ciljne publike.

  • Bralnik zaslona za dostopnost — Dokumentacija je dostopna v skladu s standardom za bralnike zaslona.
  • Prilagodljivost učenja — Dokumentacija je dostopna ljudem z različnimi kognitivnimi pristopi, senzoričnimi razlikami in nevrodiverziteto. (1).
  • Slepi ali slabovidni — Dokumentacija je dostopna ljudem, ki primarno berejo besedilo. Grafi in slike so primeri nedostopnih vrst dokumentacije.

Izvajanje

Uporaba in razširjanje zdravstvenih meritev lahko povzroči kršitve zasebnosti. Organizacije so lahko izpostavljene tveganjem. Ta tveganja lahko izhajajo iz skladnosti z GDPR v EU, z državno zakonodajo v ZDA ali z drugimi zakoni. Obstajajo lahko tudi pogodbena tveganja, ki izhajajo iz pogojev storitve za ponudnike podatkov, kot sta GitHub in GitLab. Pri uporabi metrik je treba preveriti tveganje in morebitne težave glede etike podatkov. Prosim poglej Dokument o etiki podatkov CHAOSS za dodatna navodila.

Opomba: Pri dokumentaciji bodite pozorni na ciljne skupine. Zaradi širokega spektra projektov in ljudi, ki lahko prispevajo, mora dokumentacija obravnavati različne zahteve vseh ciljnih skupin.

Strategije zbiranja podatkov

  • Uporaba orodje ki ocenjuje prijaznost do bralnika zaslona. (5) (6) ugotoviti, ali je dokumentacija prijazna do bralnika zaslona?
  • Intervju novincem, da ugotovijo, kako je dokumentacija pomagala pri (a) razumevanju procesa prispevanja in/ali (b) pomoči pri dokončanju nalog v projektu. Vzorci vprašanj za intervju:
    • Kakšne so vaše izkušnje z uporabo dokumentacije za razumevanje procesa prispevanja?
    • Kakšne so vaše izkušnje z vpogledom v dokumentacijo, ko imate vprašanje o izvajanju dela na projektu?
    • Ali ste bili zadovoljni s tehničnimi izrazi v dokumentaciji?
  • Anketa člani projekta

    • Element matrike: Ko morate poiskati informacije o procesih, politikah ali smernicah tega projekta, kaj od naslednjega opisuje vašo izkušnjo? (2)
    • Matrične vrstice so lahko:

      • Komunikacija z poštnim seznamom
      • Klepetalna komunikacija
      • Izvajanje pregledov kode
      • Postopek sprejemanja kode
      • Kodeks ravnanja
      • Uvajanje novincev
      • licenciranje
      • Blagovna znamka
      • Dodajte nove izvajalce/vzdrževalce
      • Objave projektov
      • Postopek glasovanja
      • Postopki namestitve
      • Razvoj funkcij
      • Integracija API-ja
      • Testne zbirke
      • Pregled arhitekture
      • navodila za uporabo
    • Matrični stolpci so lahko:
      • Vedno enostavno najti
      • Enostavno najti
      • Težko najti
      • Zelo težko najti
    • Več možnosti: Ali ste se ob začetku sodelovanja v projektu srečali s kakšnimi izzivi v zvezi z dostopnostjo dokumentacije (npr. jezikovne ovire, odkritost dokumentacije, struktura dokumentacije)? (2)
    • Možnosti odgovora:
      • Brez izzivov
      • Nekaj ​​izzivov
      • Več izzivov
      • Veliko izzivov
    • Odprto nadaljnje vprašanje, če odgovor ni »Brez izzivov«: Opišite primer, kdaj ste doživeli izziv, kako je izziv vplival na vas in kako ste ga, če sploh, premagali.
    • Odprto vprašanje: Kakšne predloge imate za izboljšanje pravilnikov, procesov ali smernic projekta, ki so na voljo novim sodelavcem? (2)
  • Poiščite organizirane konstrukcije glede berljivosti in možnosti pregledovanja, kot so:
    • Naslovi
    • Besedilni in kodni bloki
    • Oznake ali odstavki
    • sidra
  • Ocenite možnost iskanja tako, da upoštevate:
    • Kako enostavno lahko uporabnik najde to dokumentacijo?
    • Kako preprosto lahko uporabnik najde tisto, kar potrebuje v dokumentaciji?
    • Ali je po dokumentu enostavno krmariti s tipkovnico?
  • Zagotovite hitro mikro anketo s samo enim vprašanjem za bralce dokumentacije (tj. spodnja stran ali pojavno okno, ko zapustite stran z dokumentacijo):
    • Da/Ne vprašanje: Ali vam je bila ta stran z dokumentacijo dostopna?
    • Likertova lestvica [1-x]: Kako dostopna vam je bila ta dokumentacija?
    • Kratek odgovor: Kako se vam zdi dostopnost dokumentacije?
  • Walkthrough s predvidenimi uporabniki dokumentacije. Opazujte, kako medsebojno delujejo in uporabljajo dokumentacijo ter kje se zataknejo. To je lahko videokonferenčna seja, kjer uporabnik dokumentacije deli svoj zaslon.
  • Prosite uporabnike dokumentacije, da napišejo a dnevnik trenja in opišite, kakšne težave so imeli z dokumentacijo. To daje urednikom dokumentacije konkretne primere uporabe, da razumejo, kako izboljšati dokumentacijo za določenega uporabnika.
  • Razmislite, če različne različice dokumentacije so na voljo različnim občinstvom? Na primer lahka različica in zelo podrobna različica.

viri

  1. Odpravljanje ovir za prispevek Kubernetes za nevrodivergentne posameznike
  2. Raziskava skupnosti Apache Software Foundation 2020
  3. Ekipa za dostopnost GNOME
  4. Smernice W3C za dostopnost spletne vsebine
  5. Seznam orodij za ocenjevanje spletne dostopnosti W3C
  6. Nekaj ​​hitrih testov za oceno spletne dostopnosti
  7. Knowability - skupina, ki je specializirana za dostopnost
  8. Razmišljanja o meritvah dostopnosti
  9. Paypalov seznam smernic za dostopnost
  10. Univerzalni dizajn

Avtorji

Ta meritev je bila nazadnje pregledana 24. julija 2022 kot del postopka revizije meritev.