Документация на потребителя - studopediya

документация за потребителя (документация за потребителя): пълен набор от документи, предоставени на хартиен или друга форма, която осигурява употребата на продукта, както и да бъде неразделна част от него.

документация за потребителя, трябва да отговарят на следните спецификации.

Тегло (пълнота). документация за потребителя трябва да съдържа информацията, необходима за използване на продукта. Тя трябва да се опишат подробно всички функции, определени в описанието на продукта, както и всички потребителски функции на изискуем от програмата. Също така, граничните стойности, определени в описанието на продукта, трябва да бъдат дублирани в документацията за потребителя. Ако монтаж (монтаж) Продуктът може да се извършва от потребителя, документацията за потребителя трябва да бъдат включени насоки за инсталиране на продукт, съдържащ цялата необходима информация. Ако поддръжката на продукта може да се извършва от потребителя, документацията за потребителя трябва да бъдат включени насоки в подкрепа на програмата, съдържаща цялата информация, необходима за осигуряване на този вид подкрепа.

Коректността (коректност). Цялата информация в документацията за потребителя трябва да бъде вярна. В допълнение, на представянето на тази информация не трябва да съдържат повече от едно тълкуване и грешка.

Консистенцията (последователност). Документи, включени в комплекта на документация за потребителя, не трябва да си противоречат, взаимно и описанието на продукта. Всеки термин трябва да има същото значение във всички документи.

Яснота (разбираемост). документация за потребителя трябва да е ясно за общността на потребителите, ръководи натоварване, като например чрез използване на ИТ подходящо подбрани от гледна точка на графични вложки, изясняване обяснения и чрез връзки към полезни източници на информация.

Простота Ферис (лекота на преглед). потребителска документация трябва да бъде достатъчно прост за потребителя да учат, така че той може да се идентифицират всички описани в отношенията си към компонентите на продукта. Във всеки документ може да бъде включена и TOC Index.

Обобщавайки, ние казваме, че има спешна нужда от въвеждането на вътрешни стандарти за документиране на правилата PS, наредби, изисквания и препоръки, които са изложени в международните и чуждестранни напреднали нива. Но по време на тази работа не може да се ограничава само до прякото прехвърляне на някои международни стандарти. Необходимо е, че новите стандарти са правилно закачен с всички настоящи и бъдещи множество нормативни актове.