HandyCache форум

Дела домашние => Сайт и форум HandyCache => Тема начата: Сергей от 03 января 2007, 00:17:37



Название: Мануал, документация, руководство по НС
Отправлено: Сергей от 03 января 2007, 00:17:37
Текущий раздел документация нужно переименовать в статьи.
И создать нормальную документацию с древовидным оглавлением.

Формат статьи ну никак не подходит для написания документации.
Когда я предлагал поселится на wiki, предполагалось избавиться от многох пунктов FAQ и перенести их в документацию, которая должна состоять из глав и параграфов а не голых страниц.
Цитировать
мануал таков, что не очень вижу необходимость в чем-то еще

Сомневаюсь. Тут еще конь не валялся.


Название: Мануал, документация, руководство по НС
Отправлено: DenZzz от 03 января 2007, 00:32:35
Когда я предлагал поселится на wiki, предполагалось избавиться от многох пунктов FAQ и перенести их в документацию, которая должна состоять из глав и параграфов а не голых страниц.

Не у всех хватит терпения читать такой Мануал!
А в ФАК люди часто заглядывают, когда у них возникают проблемы, чтобы быстро их решить!
Заставлять их при этом читать громадный Мануал - это издевательство! ;)

Цитировать
Сомневаюсь. Тут еще конь не валялся.

Напиши свой Мануал, подробный! Разместим рядом и посмотрим, чей будет популярней...

P.S. Лично у меня никогда не хватает терпения дочитать до конца большие Мануалы. Приходится просто пролистывать малозначимые страницы с большим содержанием "воздуха"...  :-\
Когда мне охота что-то много почитать, предпочитаю художественную литературу!
А Мануал должен быть кратким, но информативным! ИМХО...


Название: Re: Мануал, документация, руководство по НС
Отправлено: Rick от 03 января 2007, 01:20:14
Сергей
Я прошу прощения, при переносе темы пострадало одно сообщение: сам текст я перенес, не не в виде сообщения, а только в виде текста.

Цитировать
Формат статьи ну никак не подходит для написания документации.
Давай, прежде чем выносить/предлагать категоричные суждения/выводы сначала их обсудим: я пока из твоих слов не смог понять в чем "дефект" нынешнего мануала и как же должен выглядеть "правильный" вариант.
Расскажи пожалуйста подробней.


Название: Re: Мануал, документация, руководство по НС
Отправлено: Rick от 03 января 2007, 01:46:15
Сергей, DenZzz,
Сейчас я вижу с одной стороны критику, с другой - защиту от оной. И никакого конструктива. Я прошу, во-первых, объяснить как, по мнению Сергея, следовало бы правильно написать мануал, в какой форме и виде, во-вторых, DenZzz'а дождаться этого ответа.


Название: Re: Мануал, документация, руководство по НС
Отправлено: Александр от 03 января 2007, 10:22:57
Программа интуитивно понятна без каких-либо документаций, мануалов и остальных прелестей для одаренных... Имхо.


Название: Re: Мануал, документация, руководство по НС
Отправлено: faZZ от 03 января 2007, 10:34:29
Программа интуитивно понятна без каких-либо документаций, мануалов и остальных прелестей для одаренных... Имхо.
ну не скажи, хороший мануал нужен любой программе. Допустим, врят ли новички разберутся в работе новой фичи серверы-посредники, да и не новички тоже. а фича полезная


Название: Re: Мануал, документация, руководство по НС
Отправлено: NothingAnother от 03 января 2007, 11:28:54
Программа интуитивно понятна без каких-либо документаций, мануалов и остальных прелестей для одаренных
Эка тебя!.. :o И ты готов заявить, что сможешь ответить на любой вопрос по программе? ;)


Название: Re: Мануал, документация, руководство по НС
Отправлено: Сергей от 03 января 2007, 12:46:33
Полностью согласен с тем, что мануал должен быть кратким, но информативным!
FAQ, в текущем состоянии, IMHO не удовлетворяет этому требованию. Когда возникает проблема, трудно понять - в каком разделе находится решение. Не обязательно читать полную документацию перед началом использования программы. Туда надо обращаться только когда что-нибудь непонятно, как в справочник. А для этого нужно внятное оглавление и, желательно, индекс. FAQ должен стать частью мануала. Сейчас все наоборот. Логика программы размазана по нескольким вопросам FAQ'а, который приходится читать от корки до корки, чтобы понять как работать.


Название: Re: Мануал, документация, руководство по НС
Отправлено: Сергей от 03 января 2007, 12:55:09
Оглавление должно иметь примерно такие разделы:
  • Назначение программы
  • Установка
  • Настройка
  • Логика работы
  • Описание списков
  • Регулярные выражения
  • Полезные советы
  • FAQ


Название: Re: Мануал, документация, руководство по НС
Отправлено: DenZzz от 03 января 2007, 13:25:29
Сергей

Ты предлагаешь всю информацию из разных разделов сайта засунуть в один документ...

Не так давно один из пользователей (Kiddy) создал нечто подобное в формате CHM: Файл помощи (550 Кбайт) от Kiddy (http://handycache.ru/download.php?handycache.chm.zip), но с тех пор он не обновлялся...

Займись! И будет у нас подробный Хелп с разделами, поиском, индексами и т.д.  :)


Название: Re: Мануал, документация, руководство по НС
Отправлено: YuS от 08 июля 2014, 14:45:49
Не нашел более подходящей темы...
Поправить бы документацию на сайте, там есть устаревшие моменты, вот здесь (http://forum.ru-board.com/topic.cgi?forum=5&topic=29338&start=2480#5) обсуждение было.


Название: Re: Мануал, документация, руководство по НС
Отправлено: Borisith от 13 февраля 2017, 21:38:33
Программа интуитивно понятна без каких-либо документаций, мануалов и остальных прелестей для одаренных... Имхо.
К сожалению, интуиция не у всех присутствует. Приобрёл программу для школы. Сам гуманитарий, а задачи стоят технические. Из мануала не совсем понятно, как составлять чёрные и белые списки. Возникли проблемы с настройкой Хрома, требует пароль. Непонятно как добавлят компьютеры с динамическими адресами. Вопросов тьма...