1

Тема: Документация

В планах создать так называемую "Monstra документация". Это будет архив, который можно будет скачать с сайта или форума monstra cms. В архиве будет статический сайт, что позволит изучать monstra cms на компьютере без доступа в интернет и без установки специальных программ. Обычно сейчас так делают инструкции для электронных устройств, особенно часто для принтеров. Понятно, что документ будет основной, поэтому подход к написанию тщательный. Сейчас прорабатываю структуру разделов и решил узнать ваше мнение. Что лучше, чего не хватает и тд.? Итак я предлагаю следующие категории:
1. О системе
  1.1 Лицензия
  1.2 Требования
  1.3 Установка
  1.4 Возможности
  1.5 Файловая структура
  1.6 Основные определения

2. Дизайн
  2.1 Виды шаблонов
  2.2 Структура шаблонов
  2.3 Меню
  2.4 CSS
  2.5 JavaScript
  2.6 Теги
  2.7 Блоки
  2.8 Сниппеты
  2.9 Чанки

3. Контент
  3.1 Создание страниц
  3.2 Шорткоды
  3.3 Редакторы Страниц

4. Плагины
  4.1 Предназначение
  4.2 Установка
  4.3 Файловая структура
  4.4 Написание плагина

Поделиться

2

Re: Документация

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

Google: Я найду всё!
Wikipedia: Я знаю всё!
ВКонтакте: Я знаю всех!
Internet: Без меня вы ничто!
Электричество: Молчать, суки…

Сайт Hmelex

Поделиться

3

Re: Документация

Сколько времени уже прошло. Много людей обещало перевести имеющуюся документацию.
...

Поделиться

4

Re: Документация

archi-mobile время еще не прошло. Начинаем считать заново.
Есть на английском. Можно вроде через гитхаб редактировать. Сначала ее надо закончить...

Поделиться