Как написать и подготовить статью для журнала Датагор.ру

Руководство для Автора

Уважаемый Автор, следуя этому руководству, ты избежишь многих ошибок и ускоришь публикацию своей статьи.

Прежде чем писать

Очень хорошей идеей является общение со мной до того, как ты представишь свою рукопись на рассмотрение.
Если у тебя есть идея, расскажи кратко, что собираешься писать. Если я смогу использовать твою рукопись, я дам «зеленый свет».
Может оказаться, что кто-то уже пишет статью на подобную тему, либо твоя идея не заинтересует меня, тогда я предупрежу тебя и не позволю зря потратить время на подготовку полной статьи.

Манера письма

Многие технические писатели используют абсолютно обезличенный стиль письма, жестко придерживаясь страдательного залога и избегая личных местоимений.
Я же хочу, что бы ты писал, словно общаясь с лучшим другом!
Смело пиши «я сделал то-то, я спалил транзисторы, я придумал схему» и прямо обращайся к читателю.

↑ План статьи

1. Авторское название
2. Краткая замануха-пролог, описывающая замечательные свойства конструкции и примененные интересные технические решения.
3. Кратко о себе - обязательно заполняется в вашем профиле, отображается внизу всех ваших статей.
4. История замысла, личные мысли, переживания.
5. Ожидаемые тех. характеристики готового изделия.
6. Схемы, чертежи печатных плат, фото, рисунки, диаграммы, осциллограммы, таблицы, прошивки для МК и пр.
7. Список компонентов (Part List, он же bom) - в виде текста или файликом XLS, TXT.
8. Описание особенностей схемного решения.
9. Описание требований к сборке, описание собственного опыта сборки и т. п.
10. Описание типов примененных элементов, деталей, материалов, их возможные замены, аналоги.
11. Налаживание, настройка, запуск.
12. Впечатления от работы, прослушивания и т. п. Эмоции, сравнения и т. п. Видосы, сэмплы.
13. Раздел Файлов — все прикрепленные файлы.
14. Раздел Ссылок — ссылки на использованные источники, сайты, книги, авторов.
15. «Спасибо за внимание!» и добрые пожелания читателям.

↑ Организация

Избегай использования излишних непонятных сокращений.
Обязательно проверь рукопись на грамотность, хотябы, с помощью MS Word.
В начало включи суммирующее описание статьи (20—50 слов), дающее читателю представление обо всех её достоинствах.
Например: «Статья описывает эффекты применения ООС и показывает, как можно уменьшить искажения и улучшить стабильность аудиосистемы»

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

Твой вводный параграф должен содержать описание проблемы, задачи и найденного тобой решения, должен дать понять читателю, о чем же собственно твоя статья и стоит ли тратить на неё время.

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

↑ Иллюстративный материал: схемы, чертежи, фото, видео

⇢ Фото = JPG. Фотографии должны быть в формате jpg, четкие, в фокусе, светлые, понятные. Разрешение 72...100 dpi, размер до 1600 пикселей по любой стороне. Если требуется бОльший размер и более высокое разрешение, присылай файлом в архиве 7z, zip.

⇢ Схема, чертёж, графика = PNG (хуже gif). Схемы и др. иллюстрации кроме фото сохраняем в формате png, ясные, читаемые. Хуже, но допустим при невозможности png, формат gif.
Разрешение 72...100 dpi, размер до 1600 пикселей по любой стороне. Если требуется бОльший размер и более высокое разрешение, присылай файлом в архиве 7z, zip.

⇢ Не делай коллажи, надписи жутким шрифтами на фото, др. эффекты и обработки фото, если ты не профессиональный фотохудожник.

⇢ Не присылай картинки с ватермарками (текст по картинке) сторонних сайтов! Ватермарки - это защита картинок от воровства, поэтому все такие иллюстрации нам придётся удалить. Иногда допустимо использовать картинку без ватермарка с указанием ссылки на её источник.
А правильнее всего делай фото и видео в процессе работы над проектом — это лучшие «органические, живые» иллюстрации для статьи.

⇢ Объект для съёмок должен быть достаточно освещён. Фотография должна быть чёткой, в фокусе.
Расположи объект на однотонном светлом фоне: лист бумаги, ткань, простынь и т.п. Не нужно делать съёмку на яркой пёстрой кухонной клеёнке.

⇢ Убери из кадра все посторонние предметы: ложки, кастрюли, трусы, полные пепельницы и т.п.
Смахни пыль с аппаратуры и др. поверхностей, которые буду видны.

⇢ Если на фото/видео попадаешь ты сам или твои руки - позаботься о причёске, чистоте ногтей, оденься прилично.

Мы размещаем видеоролики для статей исключительно на датагорском канале YouTube с указанием ссылки на статью. Для размещения загрузите ваши ролики на наш ftp-сервер: Датагорский ftp-сервер для видеороликов и сообщите нам об этом.

↑ Снимайте горизонтально!

Да, снимать, держа телефон вертикально, немного легче, но когда дело доходит до видео, горизонтальное положение телефона — единственное верное решение. Фильмы — широкоформатные, телевизоры также, и наши два глаза видят в "широкоэкранном" режиме.
Горизонтальная съемка позволяет захватывать больше пространства, к тому же, она универсальна. Мало найдётся любителей смотреть на узкую вертикальную полоску видео на своем мониторе или экране телевизора.

↑ Схемы и платы

Схема всегда первична! От неё пляшет чертеж печатной платы и текст статьи.
Схемы и платы должны быть отрисованы в спец. программах. Особо приветствуются проекты в DipTrace.
Доступны и популярны программы sPlan, Sprint Layout, Autodesk EAGLE.
Не желательно (но можно) применить др. популярные форматы или даже исполнить чертёж от руки (очень аккуратно) и прислать его скан или чёткое фото.

0. Подпиши и обозначь ВСЕ элементы на схеме. Для резисторов - мощность, для конденсаторов - напряжение, полярность, тип.
1. Нумеруй компоненты общепринятыми обозначениями, по порядку, слева направо и сверху вниз (C1, R12, VD7 и т.д.).
2. Сопровождай схему Списком компонентов в простом тектовом виде.
3. На чертеже ПП (на слое шелкографии S1) должны быть подписаны все позиционные обозначения элементов согласно схеме.

↑ Ссылки

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

↑ Обратная связь с читателями

Автор должен навещать свою статью, отслеживать появившиеся вопросы и комментарии и отвечать на них.
Для удобства следует подписаться на уведомления о новых комментариях, поставив соответствующую галку рядом с полем ввода комментариев.

↑ Форматы материалов

Приготовь текст статьи, сохранив его в формате простого текста (.txt), например, из Блокнота или Word.
Всё форматирование, вёрстка, украшение текста производится при размещении материалов в журнале средствами встроенного редактора.

⇢ Фото = JPG. Фотографии должны быть в формате jpg, четкие, в фокусе, светлые, понятные. Разрешение 72...100 dpi, размер до 1600 пикселей по любой стороне. Если требуется бОльший размер и более высокое разрешение, присылай файлом в архиве 7z, zip.

⇢ Схема, чертёж, графика = PNG (хуже gif). Схемы и др. иллюстрации кроме фото сохраняем в формате png, ясные, читаемые. Хуже, но допустим при невозможности png, формат gif.
Разрешение 72...100 dpi, размер до 1600 пикселей по любой стороне. Если требуется бОльший размер и более высокое разрешение, присылай файлом в архиве 7z, zip.

⇢ Коды, прошивки - в виде файлов в архиве 7z, zip.

Если ты, по предварительной договоренности, присылаешь материалы редактору по эл. почте, учти следующее:
1. Всё должно быть заархивировано (7z, zip).
2. Допустимо использование файлов MS Office.
3. Все фото, схемы и файлы, упомянутые в тексте статьи должны идти поименованными файлами в отдельной папке.
4. Если материалов оказалось слишком много для письма (болье 8...10 Мб), загружай на датагорский FTP-сервер (см. выше) и сигналь по готовности.

↑ Типичные вопросы

Если есть затруднения — свяжись со мной, там решим, что делать дальше.
Удачи!

С уважением, Игорь Котов

Камрад, рассмотри датагорские рекомендации