+  HandyCache форум
|-+  Дела домашние» Сайт и форум HandyCache» Мануал, документация, руководство по НС
Имя пользователя:
Пароль:
Страниц: [1]   Вниз
  Отправить эту тему    Печать  
Автор Тема: Мануал, документация, руководство по НС  (Прочитано 12068 раз)
0 Пользователей и 1 Гость смотрят эту тему.
Сергей
Beta tester
*****

Репутация: +9/-2
Offline Offline

Сообщений: 621



« : 03 Январь 2007, 00:17:37 »

Текущий раздел документация нужно переименовать в статьи.
И создать нормальную документацию с древовидным оглавлением.

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

Сомневаюсь. Тут еще конь не валялся.
« Последнее редактирование: 03 Январь 2007, 01:09:20 от Rick » Сообщить модератору   Записан
DenZzz
Модератор
*****

Репутация: +179/-11
Offline Offline

Сообщений: 5589



« Ответ #1 : 03 Январь 2007, 00:32:35 »

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

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

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

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

P.S. Лично у меня никогда не хватает терпения дочитать до конца большие Мануалы. Приходится просто пролистывать малозначимые страницы с большим содержанием "воздуха"...  Не в себе
Когда мне охота что-то много почитать, предпочитаю художественную литературу!
А Мануал должен быть кратким, но информативным! ИМХО...
« Последнее редактирование: 03 Январь 2007, 01:21:27 от DenZzz » Сообщить модератору   Записан
Rick
Администратор
*****

Репутация: +15/-1
Offline Offline

Сообщений: 868


WWW
« Ответ #2 : 03 Январь 2007, 01:20:14 »

Сергей
Я прошу прощения, при переносе темы пострадало одно сообщение: сам текст я перенес, не не в виде сообщения, а только в виде текста.

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

Репутация: +15/-1
Offline Offline

Сообщений: 868


WWW
« Ответ #3 : 03 Январь 2007, 01:46:15 »

Сергей, DenZzz,
Сейчас я вижу с одной стороны критику, с другой - защиту от оной. И никакого конструктива. Я прошу, во-первых, объяснить как, по мнению Сергея, следовало бы правильно написать мануал, в какой форме и виде, во-вторых, DenZzz'а дождаться этого ответа.
Сообщить модератору   Записан
Александр
Новичок
*

Репутация: +0/-0
Offline Offline

Сообщений: 4


« Ответ #4 : 03 Январь 2007, 10:22:57 »

Программа интуитивно понятна без каких-либо документаций, мануалов и остальных прелестей для одаренных... Имхо.
Сообщить модератору   Записан
faZZ
Beta tester
*****

Репутация: +0/-0
Offline Offline

Сообщений: 33


Местный кот


« Ответ #5 : 03 Январь 2007, 10:34:29 »

Программа интуитивно понятна без каких-либо документаций, мануалов и остальных прелестей для одаренных... Имхо.
ну не скажи, хороший мануал нужен любой программе. Допустим, врят ли новички разберутся в работе новой фичи серверы-посредники, да и не новички тоже. а фича полезная
Сообщить модератору   Записан
NothingAnother
Beta tester
*****

Репутация: +7/-2
Offline Offline

Сообщений: 434

Spoiler


« Ответ #6 : 03 Январь 2007, 11:28:54 »

Программа интуитивно понятна без каких-либо документаций, мануалов и остальных прелестей для одаренных
Эка тебя!.. Шокирован И ты готов заявить, что сможешь ответить на любой вопрос по программе? Подмигивающий
Сообщить модератору   Записан

Мы тоже не всего читали Шнитке!..
© В. Вишневский
Сергей
Beta tester
*****

Репутация: +9/-2
Offline Offline

Сообщений: 621



« Ответ #7 : 03 Январь 2007, 12:46:33 »

Полностью согласен с тем, что мануал должен быть кратким, но информативным!
FAQ, в текущем состоянии, IMHO не удовлетворяет этому требованию. Когда возникает проблема, трудно понять - в каком разделе находится решение. Не обязательно читать полную документацию перед началом использования программы. Туда надо обращаться только когда что-нибудь непонятно, как в справочник. А для этого нужно внятное оглавление и, желательно, индекс. FAQ должен стать частью мануала. Сейчас все наоборот. Логика программы размазана по нескольким вопросам FAQ'а, который приходится читать от корки до корки, чтобы понять как работать.
Сообщить модератору   Записан
Сергей
Beta tester
*****

Репутация: +9/-2
Offline Offline

Сообщений: 621



« Ответ #8 : 03 Январь 2007, 12:55:09 »

Оглавление должно иметь примерно такие разделы:
  • Назначение программы
  • Установка
  • Настройка
  • Логика работы
  • Описание списков
  • Регулярные выражения
  • Полезные советы
  • FAQ
Сообщить модератору   Записан
DenZzz
Модератор
*****

Репутация: +179/-11
Offline Offline

Сообщений: 5589



« Ответ #9 : 03 Январь 2007, 13:25:29 »

Сергей

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

Не так давно один из пользователей (Kiddy) создал нечто подобное в формате CHM: Файл помощи (550 Кбайт) от Kiddy, но с тех пор он не обновлялся...

Займись! И будет у нас подробный Хелп с разделами, поиском, индексами и т.д.  Улыбка
Сообщить модератору   Записан
YuS
Ветеран
*****

Репутация: +27/-3
Offline Offline

Сообщений: 628


crazy


« Ответ #10 : 08 Июль 2014, 14:45:49 »

Не нашел более подходящей темы...
Поправить бы документацию на сайте, там есть устаревшие моменты, вот здесь обсуждение было.
Сообщить модератору   Записан
Borisith
Новичок
*

Репутация: +0/-0
Offline Offline

Сообщений: 1


« Ответ #11 : 13 Февраль 2017, 21:38:33 »

Программа интуитивно понятна без каких-либо документаций, мануалов и остальных прелестей для одаренных... Имхо.
К сожалению, интуиция не у всех присутствует. Приобрёл программу для школы. Сам гуманитарий, а задачи стоят технические. Из мануала не совсем понятно, как составлять чёрные и белые списки. Возникли проблемы с настройкой Хрома, требует пароль. Непонятно как добавлят компьютеры с динамическими адресами. Вопросов тьма...
Сообщить модератору   Записан
Страниц: [1]   Вверх
  Отправить эту тему    Печать  

 
Перейти в: