Skip to content.

www.linux-os.ru

Sections
Personal tools
You are here: Home
Views

articles

last edited 10 months ago by avl

Основа информационного наполнения сайта www.linux-os.ru - статья.

Статья, это логически завершенный текст, полностью раскрывающий поднятую в нем тему.

Обычно статья состоит из следующих частей:

  • вступление, в котором объясняется, о чем и зачем будет идти речь
  • основная часть, в которой непосредственно раскрывается смысл статьи
  • выводы, в которых дается оценка достигнутых результатов.
  • ссылки по теме, по которым находятся использованные автором материалы или какие то подробности.
  • глоссарий, в котором раскрываются малоизвестные термины, использованные в статье.

Хорошая статья не оставляет вопросов после прочтения и дает пищу для обобщений из прочитанного.

Статья показывает уровень технической грамотности автора. Она должна быть простой по форме, понятной, не "замученной" в изложении и исчерпывающей по смыслу.

В русском языке в статьях не принято обращатся непосредственно к читателю. Не используют оборот "Для того, чтобы получить XXX нажмите кнопку YYY". Вместо этого используют третье лицо - "для достижения XXX можно использовать YYY".

Хорошая статья не должна содержать грубых орфографических ошибок. Модераторы при публикации вычитывают материалы и имеют право исправлять такие ошибки без каких бы то ни было согласований. На самом деле нико не ждет, что украинец, белорус или тем более прибалт, для которого русский язык только второй или третий, будет писать безупречно грамотно, но каждый должен быть готов к тому, что его ошибки будут молча и оперативно исправлены по мере их выявления.

Технически статья может быть оформлена как документ или wiki page. Позволю себе порекомендовать использовать для статей именно wiki page по следующим причинам:

  • Формат. wiki page можно создавать как reStructured текст. Это значительно более мощьное средство (линки, таблицы, стили etc), нежели structured text, который доступен в любом документе. В тоже время это более простой в использовании формат, нежели html.
  • История правок. wiki page позволяет отсмотреть историю исправлений и таким образом держать руку на пульсе девелопмента как самому автору, так и потенциальным соавторам, модераторам и читателям.
  • К wiki page можно делать комментарии. Это полезно для всех.

Недостатки тоже есть:

  • wiki page не имеет статуса "опубликованный". Это значит, что появление статьи обязательно нужно аннотировать отдельными элементами.
  • Поля short name и name у wiki page должны совпадать и быть на английском, иначе проблем не оберетесь.
  • Переименование wiki странички должно делаться явно, кнопкой "rename". Попытка переименовать страницу в режиме редактирования приводит к ошибке.

Аннотирование статьи.

Когда статья готова, очень уместно создать новость по этому поводу. Пример такой новости можно увидеть здесь. Новость необходима для читателей, чтобы узнать о существовании статьи, модераторам, как знак к интеграции статьи в общую структуру сайта и всем остальным для ее обсуждения.