Сайт | Скачать | Видео | Wiki

Автор Тема: О том, как правильно писать HOW-TO.  (Прочитано 3972 раз)

0 Пользователей и 1 Гость просматривают эту тему.

Оффлайн RulllJazzz

  • Постоялец
  • ***
  • Сообщений: 172
  • Репутация: +16/-1
  • Автор темы
Для начала пару комментариев от Kazm (из старой темы):

  • Если вы заметили, я во всех названиях тем пишу PuppyRus Linux. Это не прихоть - так страницы лучше индексируются - потом другим людям будет легче найти наши HOW-TO.
  • Ну конечно с орфографией надо дружить  ;), хотя и у меня куча очепятков...

Теперь мои воззрения на то, как это должно выглядеть и почему:
Обратимся для примера к одной из тем по оформлению JWM данного раздела.

Что на мой взгляд представляет собой HOW-TO:
Разумеется, это документ, который повествует о том, как добиться того-то и того-то. Но с одной оговоркой. Документом будут с большой долей вероятности пользоваться малоподготовленные пользователи с целью научиться делать манипуляции, описанные в нём. Поэтому...

В связи с этим документ должен быть составлен таким образом, чтобы у пользователя решались старые вопросы (для решения которых он, собственно и использует HOW-TO) и не возникало при этом новых.

Если документ составлен недостаточно подробно, он конечно имеет плюс в том, что заставляет человека несколько озадачиться и поискать недостающую информацию ещё где-то. Это развивает голову. НО... Практическая ценность такого HOW-TO падает, поскольку  документ будет содержать только часть (пусть и большую) всей необходимой информации. И будет иметь информационную ценность приблизительно равную выдачам по запросу в google.

Поэтому если уж браться писать HOW-TO, то писать его ОТ и ДО! Вернёмся к теме про оформление JWM. Ознакомившись с текстом становится понятно - какие файлы отвечают за оформление JWM и где их можно найти.



В чём подвох:
Вариант оформления системы (который можно найти в указанном месте) и вариант, предложенный автором, по сути одно и то же. Если открыть указанные файлы, там не совсем понятно - что, где и для чего менять. Этим абитуриент обрекается на длительный эксперимент по выяснению - что для чего.

Далее можно обратить внимание на строку:
Цитата
Для эстетического соответствия темы с треем надо подкорректировать файл /root/.jwmrc-tray , заменив в нем секцию...
(далее пример с кодом).

Нет пояснения - что менять, на что и почему. Опять метод проб и ошибок. Опять абитуриент страдает.  :)
То есть мы сообщили - что искать, где искать, но не объяснили, что со всем этим потом делать. Товарищ, понятное дело, сам догадается.

Разумеется догадается, я же догадался. НО... если вам кажется, что тут всё очевидно и пояснения не нужны, то вам HOW_TO не нужен. Это первое... Второе - если вы возьмётесь за написание HOW_TO с таким мнением, обязательно забудете упомянуть о какой-нибудь несущественной мелочи, которая для вас является само-собой разумеющимся фактом, а для пользователя фактом, ещё не осознанным. То есть HOW-TO получится низкого качества.



Чего не хватает:
  • Комментариев в файлах тем, поясняющих, что к чему.
  • Самих файлов, прикреплённых к сообщению для примера.
  • Ссылки на ресурс, где можно посмотреть цвета, раз уж мы о темах оформления говорим.


Я конечно не истина в последней инстанции ни разу, но, как мне кажется, для неподготовленного пользователя, не дружащего с английским, вот так:




будет куда более понятно, чем вот так:




Ресурс-справочник по цвету, а также...

Прикреплённые файлы:
  • Дерево каталогов с файлами темы JWM.
« Последнее редактирование: 08 Август 2010, 16:05:43 от RulllJazzz »