Ответы:
1 Полнота (в доках должно быть исчерпывающее, полное описание ПО)
2 Понятность (документация должна быть написана простым,доходчивым для конечного пользователя языком)
Насчет полноты не знаю, потому что вряд ли я видел на своем веку АБСОЛЮТНО полную документацию к ПО... Поэтому думаю, что:
1. Документация к ПО должна быть написана на том профессиональном языке, котороый понимает пользователь.
2. Она должна содержать большое количество примеров.
1. В которой легко найти необходимую информацию.
2. Должна быть написана очень понятным языком.
1. Полнота информации.
2. Удобная и продуманная организация информации.
Лучшая документация - ясный исходный код.
Чтобы документация была организована не с одной, а нескольких сторон - моделируя интерфейс, а также типы задач, для решения которых будет использоваться система.
Чтобы в описаниях различных функций говорилось не только, что оно делает, для чего надо, а также где это особенно удобно использовать, в т.ч. в связке с какими другими функциями.
Я пару лет назад работала менеджером по проектам в конторе занимающийся разработкой ПО. И в мои должностные обязанности входило какраз написание документации. В общем, если в кратце, то этот аспект деятельности меня мало волновал, и делался он на от*бись, или вообще скидывался на подчинённых. Пока однажды я не купила pinacle studio (монтажная программа) и от нечего делать решила почитать к ней мануал. У меня было такое ощущение, что читаю художественную литературу... Программа по сути дела ориентированна на домохозяек (интерфейс до безобразия прост и интуитивен, кто угодно разберётся) а тут мануал на 300 страниц, да ещё и так здорово изложенный. Кароче говоря, меня это заставило в корне пересмотреть своё отношение.
Теперь отвечаю на вопрос :
17 лет назад