Требования для авторов учебника к предоставляемым материалам

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

Предисловие

Маркетолог спрашивает программиста: в чём сложность поддержки большого проекта?

Программист: ну представь, что ты писатель и поддерживаешь проект "Война и мир". У тебя ТЗ - написать главу как Наташа Ростова гуляла под дождём по парку. Ты пишешь "шёл дождь", сохраняешь, вылетает сообщение об ошибке "Наташа Ростова умерла, продолжение невозможно". Почему умерла? Начинаешь разбираться. Выясняется, что у Пьера Безухова скользкие туфли, он упал, его пистолет ударился о землю и выстрелил в столб, а пуля от столба срикошетила в Наташу. Что делать? Зарядить пистолет холостыми? Поменять туфли? Решили убрать столб. Получаем сообщение "Поручик Ржевский умер." Выясняется, что он в следующей главе облокачивается о столб, которого уже нет...

Ай-ай-ай, к чему все эти сложности? Согласен, на первый взгляд все может показаться сложным и непонятным. Но если вдуматься, то все очень логично. Ведь если не будет четкой структуры, то работая над такими большими проектами очень легко запутаться. Все в голове не удержишь. Невозможно запомнить где какой файл лежал, когда и кем редактировался, что в нем изменилось. А попробуйте вспомнить все это через полгода. Еще больше проблем возникает, когда над одним проектом работает команда. Отсутстствие общей структуры у проектов, куча несовместимых форматов данных и прочее отнимают очень много времени. Поэтому, даже хоть какая-то общая структура, стандартизация, пусть даже далеко не совершенные, позволяют сэкономить очень много времени. Но самое важное заключается в том, что за счет использования набора соглашений в проекте можно автоматизировать множество рутиных процессов.

Электронные учебники и книги - это уже не какое-то туманное будущее, а обыденность (почему-то только Россия как всегда отстает). Современные учебники - это не что-то "деревянное", а постоянно обновляющееся, интерактивное. Старые подходы к работе сейчас крайне неэффективны, очень длительны. Пора перестраиваться под новую реальность.

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

Критика и конструктивное обсуждение приветствуется.

Структура проекта

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





Требования к изображениям

Форматы изображений: TIFF, JPEG, PNG, SVG.

Оптимальное разрешение определяется из расчета, что большая из сторон равна 2560px. Минимально допустимый размер меньшей из сторон - 480px. Ограничений на максимальный размер нет.

Цветовой профиль для изображений - RGB/sRGB. Допускается использование других цветовых профилей, но в таком случае цветовой профиль должен быть указан в названии файла, например image.CMYK.tif.

Очень важно, чтобы были сохранены исходные файлы (PSD, CDR, SVG, XCF и т.д.).

Для схем и т.п. иллюстраций должна применятся векторная графика. Формат для векторной графики - SVG.

Очень важным моментом является соблюдей пропорций. Рекомендуется применять только следующие пропорции: 1×1, 1×2, 2×3, 3×4, 5×8, 16×9.

Требования к аудио

Аудио, которые записываются в студии по вашему заказу, должны быть записаны в формате WAV 48kHz/24bit, обработаны компрессорами и нормальзованны по уровню сигнала. Просите также чтобы вам предоставили необработанные исходные аудиозаписи в качестве резервной копии. Для всех остальных записей формат и качество могут быть любыми (понятно же, что не всегда не всегда удается найти сразу в хорошем качестве), но помните, что чем выше качество, тем лучше. Не забывайте об авторских правах, обязательно помечайте источник, откуда был взят файл.

Аудио, которое должно быть добавлено к основному тексту, должно располагаться в папке Audios/Audio. Имя файла было цифровым (например, 1.wav, 2.wav и т.д.). Желательно (но не обязательно), чтобы номера файлов соответствовали тому порядку, в котором они будет размещены в тексте. Описание аудиофайлов должно храниться в файле Audio/list.md и включает в себя: название файла, название аудиозаписи и место, куда оно должно быть вставлено. Шаблон файла выложу позже.

Требования к видео

На данный момент у меня нет особых требований к видео, которое должно создаваться по заказу авторов. Стандартным разрешением для видео считать FullHD (1920×1080px).

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

Видео, которое должно быть доступно оффлайн, должно располагаться в папке Videos/Video. Имя файла было цифровым (например, 1.avi, 2.mp4 и т.д.). Описание и наименование файлов должно храниться в файле Video/list.md и включает в себя: название файла, название видеозаписи и место, куда оно должно быть вставлено. Шаблон также будет выложен позже.

Дополнительное видео (которое не должно быть доступно оффлайн) должно располаться на общедоступных хостингах (Youtube.com, Vimeo.com, Rutube.ru, VK.com). Крайне желательно, чтобы видео было с официальных каналов, а не были бы копиями. Если видеозапись из VK.com, то оно должно быть добавлено в видеозаписи группы БУР НИИ НО, комментарии к видео должны быть отключены.