Рекомендация. Как правильно написать статью.

Alexandre

PHPПенсионер
Рекомендация. Как правильно написать статью.

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

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

Повторю слова векого генния сюреализма С.Дали:
сперва научись писать как гении, а потом уже пиши как хочешь.

Статьи, оказвыется, писать довольно-таки легко, зная что искусство написания базируется на трех китах:
  • Структура.
    Стиль.
    Содержание.
Содержание - это то о чем мы хотим написать, наши знания, которые надо научиться правильно оформлять.
Стиль - приходит с опытом, - это наши умения в выражении наших мыслей.
И остается последнее - Структура.

Как правило, Стуктура представления у всех статей одинаковая. Следуя всегда рекомендациям, придерживания определенной структуры, Вы облегчите восприятие, особенно новичкам.

Итак, типовая структура:

Название. Надо осторожнее использовать название статей.
Например, задумали написать статью об особенностях PHP5. Какие могут быть варианты:
отличия или Особенности пхп5
Что нам привнес пхп5
пхп5 наступает на пятки
... и прочее.
если мы сравниваем его с пхп4, то лучше выбрать первый вариант, если обсуждаем перспективы то третий.


Введение.
В статье можно явно его не указывать. Но в начале статье должно быть пара фраз о сути проблемы, зачем все это нужно и что из этого в конечном случае вытекает.
Короче говоря - цель статьи.

Вернемся к примеру, про пхп5
Во введении надо написать, что вот уже как полгода (или вчера) вышел новый релиз, пора ознакомится с его особенностям. В статье идет сравнение с пхп4.

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

В нашем примере должен быть общий абзац отличий:
- БД
- улучшена поддержка классов
- исключения
- прочее...

Далее либо отдельным пунктом, либо в тексте идет раскрытие каждой из частной проблемы, ее подробное описание, связи, пути решения

т.е следуя примеру: полное изложения вышеперечисленных пунктов, например раскрытия БД,
в чем состоит отличия работы с БД в пхп,
новые возможности,( лучше изложить их структурно а потом их раскрыть следуя рекомендации об описании проблемы в общем, но уже применительно к БД )
раскрытие и описание каждой функции...
Пример использование функции в конце каждого описания, или для всей БД группы функций в конце темы.

Далее аналогичны классы...исключения...

и наконей Заключение.

краткие выводы,
чего мы научились,
где прочитать про это поподробнее,
ссылки
 

_RVK_

Новичок
Alexandre Не задумывался статью про это написать? Я серьезно. Такие рекомендации можно разместить на Деталях, думаю это поможет их наполнению.

Со своего небольшого опыта, скажу. Тут нужно соблюсти баланс. Черезменная структурированность пагубно сказывается на литературном качестве статьи. Статья, где все четко разложенно по полочкам, читается как справочник. Знания ты получаешь, спору нет, но читать неинтересно. Потому многие и не читают мануалы, они скучны, хотя и четко структурированны. Вот здесь и заключается професианолизм. Нужно писать интересно, но и так чтоб нужная информация была видна сразу.

И еще. Статья должна оставлять пищу для ума, свободу выбора. Разжеванная пища не так вкусна. Автор статьи должен рассказывать и советовать, но не настаивать. Статья должна давать вектор направления и угол его отклонения, а не конечную точку.

В примерах должна быть конкретика, но незавершенность. В словах рекомендации, но не догма. Лишь некоторые общепринятые аксиомы должны быть в стиле, "так делать нельзя", но не "делать так и только так".
 

Alexandre

PHPПенсионер
Alexandre Не задумывался статью про это написать? Я серьезно. Такие рекомендации можно разместить на Деталях, думаю это поможет их наполнению.
нy - можно...я сейчас к конференции готовлюс, по этому только после сентября
 

fisher

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

Alexandre

PHPПенсионер
что искусство написания статьи не является формализуемым
fisher согласен, но также
сперва научись писать как гении, а потом уже пиши как хочешь.
хочешь, чтоб тебя читали - пиши либо как гений, либо придерживайся формальным правилам,

а то - иногда, начинаешь читать, - уши вянут от неумения излагать мысли.

Искусство познается в труде и поте, все Великие гении состояли из 90% труда и 10% таланта.
 
Сверху