Про хелпы и мануалы
Все вокруг, конечно, крутые айтишники, а я — хрен с горы, но я все равно позволю себе следующее категорическое заявление.
В хелпах, мануалах, факах и прочих технических описаловках для простых пользователей нужно избегать внутренних ссылок на соседние материалы.
Перелинковка — это википидорство.
Мануал должен быть пошаговым и последовательным. Лучше, если он будет длиннее, чем если он будет отсылать пользователя к десятку других страниц.
Исключение: обзорная страница, призванная направить пользователя на путь истинный. Например, «если вас интересует общая информация — читайте
общую информацию
, а настройки разобраны подробно в разделе
настройки
».
Наличие внизу страницы (или сбоку) списка ссылок «также читайте вот это» — правильно.
Если избежать ссылок совсем не получается, то их нужно минимизировать. Например, вот так:
Один раз — не википидорас.
Источник:Записки безработного
В хелпах, мануалах, факах и прочих технических описаловках для простых пользователей нужно избегать внутренних ссылок на соседние материалы.
«Внешний вид выглядит примерно так, но может отличаться в зависимости от
настроек
параметра
такого-то
, вот
этого
и еще
хрен знает какого
. Например, если ваш
системный администратор
сделал
такую штуку
вот в этой
менюшке
такой-то
программы
, то…»
настроек
параметра
такого-то
, вот
этого
и еще
хрен знает какого
. Например, если ваш
системный администратор
сделал
такую штуку
вот в этой
менюшке
такой-то
программы
, то…»
Перелинковка — это википидорство.
Мануал должен быть пошаговым и последовательным. Лучше, если он будет длиннее, чем если он будет отсылать пользователя к десятку других страниц.
Исключение: обзорная страница, призванная направить пользователя на путь истинный. Например, «если вас интересует общая информация — читайте
общую информацию
, а настройки разобраны подробно в разделе
настройки
».
Наличие внизу страницы (или сбоку) списка ссылок «также читайте вот это» — правильно.
Если избежать ссылок совсем не получается, то их нужно минимизировать. Например, вот так:
«Внешний вид выглядит примерно так, но может отличаться в зависимости от настроек. Настройки подробно рассмотрены в
соответствующем разделе руководства
.
соответствующем разделе руководства
.
Один раз — не википидорас.
Источник:Записки безработного