Рекомендации по написанию статей

Общие сведения

Как начать

Чтобы присоединиться к сообществу необходимо лишь зарегистрироваться. Это откроет доступ к написанию и редактированию статей. После авторизации на справа (на компьютерной версии сайта) у вас появится пункт "Создать" и "Редактировать" (Create и Edit в английской версии интерфейса).

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

Рекомендации по написанию статей

• Не создавайте книги и главы для одной-двух страниц. Излишняя вложенность затрудняет поиск информации.
• Используйте заголовки. Это улучшает работу поиска по сайту, облегчает навигацию по тексту и позволяет логически разделить текст.
• Используйте форматирование текста. Это облегчает его восприятия и повышает концентрацию читателя.
• Не публикуйте недописанные статьи. В случае, если вы набросали черновик, вместо публикации сохраните его как черновик. Меню управления черновиками находится над окном редактора текста. По мере набора текста происходит автоматическое сохранение.
• Старайтесь чётко и ясно структурировать мысли. Избегайте использования жаргонной лексики за исключением моментов, когда жаргон является общеизвестным или касается тематики электротранспорта. На потенциально незнакомые читателю слова оставляйте ссылку в глоссарий. Со способами добавить ссылку можно ознакомиться ниже.
• В случае добавления ссылок на внешние ресурсы, корректно обозначайте их текстом, в случае ссылок на приобретение товаров, оставляйте фото приобретаемого товара. Также рекомендуется оставлять подпись к ссылке. Всё это поможет читателю найти описываемый предмет или тему в случае, если используемая ссылка потеряет актуальность.
• При редактировании чужой статьи указывайте список изменений. Это поможет в разрешении спорных ситуаций и препятствию войне правок.

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

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

Проверка орфографии

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

Существует бесплатный спеллчеккер LanguageTool, представленный в виде отдельного сайта, а также плагинов для различных приложений. Плагин для браузера Chrome

Разметка текста и оформление статей

Shelves, Books, Chapters, pages:

Bookstack имеет  следующие сущности Шкафы, книги, главы, страницы. По сути своей это уровни вложенности, дающие возможность разграничения прав.  Самый верхний уровень  — шкафы. Здесь происходит глобальное разделение направленностей статей будь то разные самокаты или иные темы. Далее идут книги  — разделение статей по различным темам, касающимся одного направления, например обслуживание, модернизация, личный опыт. Следующим, но не обязательным уровнем являются глав. Их можно использовать для отделения отдельных статей по тематики, как к примеру механические доработки, электрические доработки. Последним и основным уровнем являются страницы, содержащие непосредственно текст. 

Выбирайте раздел и уровень вложенности с умом. Не следует создавать новые книги или главы ради одной статьи.

Превью книг:

Картинка на превью должна иметь разрешение 440х250. При этом 60 пикселей снизу и сверху будут не видны при стандартном отображении книг (List) и 40 пикселей снизу и сверху не будут отображаться в режиме Grid.

Шаблон иконки книги для Photoshop: Book.psd

Как основной фон должна использоваться данная картинка: BG.png

Основное изображение должно визуально подходить иконкам других книг.

Заголовки:

Bookstack имеет 4 уровня заголовка. Заголовки обеспечивают как смысловое разделение текста, так и помогают в навигации по статье.

Шрифты:

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

Выделение текста:

Для выделения текста может использоваться Inline code (Можно найти в разделе Formats),  либо Callouts

Пример Callout info

Callout Success

Callout Warning

Callout Danger

Общее:

Для отмены выделения текста (заголовки, Callouts, цитаты) можно использовать тип текста Paragraph или кнопку очищения стиля T_x.

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

Акценты в тексте:

Элементы, на которых следует сделать акцент можно выделять с помощью Inline code с применением бордового цвета и жирного текста.

Цитаты и прочее:

Цитаты выделяются через формат Blockquote

Ссылки

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

Ссылки внутри статьи

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

Ссылки между статьями

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

Ссылки на заголовок внутри другой статьи

К сожалению, удобного способа оставить ссылку на заголовок в другой статье нет. Это придётся делать вручную.

1. Откройте статью на заголовок которой вам нужна ссылка.
2. В меню навигации (слева) найдите ссылку на нужный заголовок.
3. Нажмите по ссылке правой кнопкой мыши и скопируйте её.
4. Вернитесь в редактор текста правящейся статьи
5. В редакторе нажмите на иконку ссылки и в поле Url вставьте скопированную ссылку.

Ссылки к конкретным моментам в статье

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

Подпись ссылки

Чтобы добавить подпись на ссылку, которая отобразится при наведении курсора, заполните поле Title при добавлении ссылки.

Спойлеры

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

Для того чтобы убрать контент под спойлер, необходимо открыть код страницы и добавить следующие теги:

<details>
  <summar><strong>Заголовок спойлера</strong></summary>
  Контент спойлера
</details>

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

Текст после спойлера.