Документация, която отговаря на продукта
Ясна и структурирана документация за инсталиране, настройка и разширяване на ModularPress. Писана за реални проекти, а не за демо инсталации.
- Понятията в продукта, обяснени без модни думи
- Модулите са документирани така, както изглеждат в админ панела
- Примери, базирани на реални случаи
Започнете от основите
Документацията следва същия начин на мислене като самия продукт. Започвате с основните понятия и постепенно стигате до модули, работни процеси и интеграции.
Основни понятия
Научете как ModularPress организира съдържанието, потребителите и конфигурацията. Този раздел обяснява как се свързват модулите, страниците и правата, преди да преминете към по-сложните функции.
Започнете оттук, ако продуктът е нов за вас или планирате първата си инсталация.
Модули
Всеки админ модул е документиран като самостоятелен градивен елемент с ясна отговорност и обхват.
Документацията на модулите следва структурата, която виждате в раздела „Модули“.
Конфигурация
Инсталиране, настройка на средата и системни настройки, обяснени стъпка по стъпка.
Включва структурата на базата данни, правата и особеностите при внедряване.
Как е организирана документацията
Преглед на продукта
Обобщено обяснение как работи ModularPress като система. Обхваща философията на админ панела, разделянето на модули и дългосрочната мащабируемост.
Тясно свързан със страницата на продукта.
Справочник на модулите
Подробна документация за всеки модул, наличен в админ панела. Включва „Потребители“, „SEO“, „Менюта“ и други.
Страницата на всеки модул обяснява предназначението, модела на данните и типичните работни процеси.
Ръководства по случаи на употреба
Практически ръководства, изградени около реални работни процеси като уебсайтове, клиентски портали и вътрешни инструменти.
Тези ръководства съответстват на страниците в „Приложения“.
За кого е написана документацията
Разработчици
Разберете модела на данните, границите между модулите и точките за разширяване, без да разчитате кода наобратно.
Научете как си взаимодействат модулите и къде е мястото на собствената логика.
Редактори и екипи за съдържание
Научете как работят публикациите, страниците, менютата и процесът на публикуване, без технически шум.
Тясно свързано с модули като „Публикации“, „Категории“ и „Менюта“.
Експлоатация и администратори
Внедряване, резервни копия, права и особености на продукционната среда, обяснени ясно.
Обхваща области като „Настройки“, „Сигурност“ и контрол на достъпа.
Как да използвате документацията
Документацията не е предназначена да се чете от началото до края. Използвайте я като справочник, докато работите в админ панела.
- Започнете с прегледа на продукта, за да разберете системата
- Четете документацията на модула, когато включвате или използвате нов модул
- Използвайте ръководствата по случаи на употреба, за да планирате реални инсталации
- Връщайте се към документацията за конфигурация при внедряване или мащабиране
Търсите нещо конкретно?
Ако не намирате това, което ви трябва, в документацията, най-добрата следваща стъпка е да разгледате модулите директно или да ни попитате.
