Документација је више од веб-сајта

Вики Српски (ћирилица)

Зашто документацију треба обликовати за онлајн читање, офлајн употребу, штампу и дугорочно очување, уместо да се третира као садржај намењен само вебу.


О документацији се често говори као да је њен коначни облик само картица у прегледачу. Та претпоставка је практична, али непотпуна. Добра документација обично мора да функционише у више контекста: за онлајн читање, офлајн читање, штампу, PDF извоз, наставу, прегледне састанке и дугорочно архивирање.

Када се документација третира као искључиво веб, тимови обично оптимизују навигацију, брзо повезивање и интерактивне елементе, а занемарују преносивост. Због тога садржај постаје теже поново користити у обуци, теже архивирати и теже делити у институционалним окружењима где су PDF извоз или штампани пакети и даље важни.

Подршка за штампу важна је и за приступачност. Неки читаоци боље задржавају информације на папиру. Неки се процеси прегледа и даље одвијају у просторијама где су штампани материјали практични. Неки архивски или набавни контексти захтевају стабилан излаз за штампу. Подршка за штампу зато није носталгија. Она је део тога да документација буде употребљивија у стварним околностима.

LetBooks то сада третира изричито. Документациона платформа треба да ради онлајн и офлајн, а штампа или PDF излаз сматра се подржаним начином употребе. Зато модел за штампу задржава садржај, атрибуцију, ауторска права и одрицање од одговорности, а уклања навигациони вишак, претрагу и друге интерактивне елементе који на папиру не помажу.

Та политика одражава и начин размишљања о очувању. Документациони систем који може чисто да се одштампа лакше је архивирати, цитирати, делити на радионицама и користити у образовним окружењима. Тако постаје мање зависан од једног начина испоруке.

Документација је зато више од веб-сајта јер знање у њој мора да преживи више од једног начина читања.