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

Вики Македонски

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


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

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

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

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

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

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