четверг, 16 августа 2012 г.

Документация в блоге упорядочена

Good news, everyone! (c) Наконец-то, я упорядочил все сообщения, которые являются руководствами (guides) по Composite C1 CMS.

На новой странице Документация собраны ссылки на такие сообщения в последовательной форме, начиная с общей информации о Composite C1 CMS, ее установке, запуске и публикации сайта и заканчивая конкретными сообщениями-инструкциями о том, как что-то сделать в Composite C1 CMS - "пораздельно" (например, создать функцию определенного типа или использовать мета поля на страницах).

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

Мне же эта упорядоченность поможет потихоньку пересмотреть сообщения на предмет их устарелости и неактуальности. Пока что я планирую помечать такие сообщения, например: "Эта информация устарела" - и писать более свежие статьи на ту же тему, как я, например, сделал это для пакета "Блог" (см. "Как создать  блог в Composite C1 (2)").

Вот какие основные разделы я создал на данный момент на странице "Документация":

  1. Общая информация
    Что такое Composite C1 CMS, лицензии, установка и запуск системы, шаблоны сайтов, публикация сайта, поддержка SQL, устранение неполадок, журналирование  и т.п.
  2. Административная консоль
    Общая информация об админке, разделах в админке, стартовой странице, локализации админки и т.п
  3. Контент и мультимедиа
    Сообщения связанные с этими разделами админки: редактор страниц, вставка изображений, SEO страниц и т.п.
  4. Макет
    Сообщения связанные с этим разделом админки: шаблоны и типы страниц, а также эталонные страницы
  5. Типы данных
    Сообщения связанные с разделом "Данные" в  админке: все виды динамических типов - глобальные типы, папки данных, мета-типы, а также статические типы и поставщики данных
  6. Функции
    Сообщения связанные с этим разделом админки: внешние и встроенные C# функции, XSLT  функции, визуальные  функции, SQL  функции, а также Razor функции  и User Control функции.
  7. Пользователи
    Сообщения связанные с этим разделом админки: пользователи и группы пользовталей для админки, права и доступ в админке.
  8. Пакеты
    Сообщения связанные с этим подразделом админки: установка, создание, локализация, настройка своего сервера пакетов и т.п.
  9. Система
    Сообщения связанные с этим разделом админки: конфигурация URL-адресов и т.п. (Подраздел "Пакеты" вынесен в отдельную группу.)
  10. Внешние элементыИнформация о том, как можно использовать на сайте внешние компоненты, например, ASP.NET User Controls или MVC.
  11. Административная консоль / Приложения
    Тема создания и использования приложений/расширений для админки.
Группировка эта - условная и может меняться со временем. (Пока я писал это сообщение, уже внес два изменения...)

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

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

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

Комментариев нет:

Отправить комментарий