мета-данные страницы
Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
документация_агбис [22.01.2020 15:35] admin |
документация_агбис [02.09.2021 20:22] (текущий) |
||
|---|---|---|---|
| Строка 1: | Строка 1: | ||
| - | ====== Документация в системе АГБИС ====== | + | ====== Документация Компании АГБИС ====== |
| ===== Принципы документирования ===== | ===== Принципы документирования ===== | ||
| Строка 16: | Строка 16: | ||
| **Администратор** - работник организации клиента или сторонний специалист (в том числе сотрудник компании-партнера), выполняющий функции настройки и администрирования проектов.\\ | **Администратор** - работник организации клиента или сторонний специалист (в том числе сотрудник компании-партнера), выполняющий функции настройки и администрирования проектов.\\ | ||
| + | |||
| + | ===== Требования по содержанию для клиентов ===== | ||
| + | 1. Текст не должен быть перегружен техническими терминами.\\ | ||
| + | 2. Не забывать про визуализацию (схемы, скриншоты).\\ | ||
| + | 3. Текст должен быть разбит на абзацы. Крупные блоки должны иметь заголовок.\\ | ||
| + | 4. Крупные не связанные друг с другом блоки должны быть разными файлами. Например, не должно быть на одной странице настройка функции и ее использование в работе. При этом хорошо иметь файл с содержанием, то есть ссылками на все отдельные файлы относящиеся к теме.\\ | ||
| + | 5. Не дублировать материал, если что-то уже описано, то давать ссылку.\\ | ||
| + | |||
| + | ===== Требования к стилистике ===== | ||
| + | 1. Текст должен быть написан от 3 лица. Например "Необходимо открыть локальные настройки Агбис Химчистки и ...". То есть ПЛОХО написать "Открываем настройки" и уж тем более "Открываешь настройки".\\ | ||
| + | 2. В одном предложении одинаковые слова нужно заменять синонимами. Например, "Нужно, необходимо, требуется".\\ | ||
| ===== Документация проекта ===== | ===== Документация проекта ===== | ||
| Строка 21: | Строка 32: | ||
| Основная страница проекта должна быть в открытом доступе, но может содержать внутри себя тэги, ограничивающий просмотр той или иной информации.\\ | Основная страница проекта должна быть в открытом доступе, но может содержать внутри себя тэги, ограничивающий просмотр той или иной информации.\\ | ||
| - | Разделы и подразделы документации проекта, базовая структура: | + | Разделы и подразделы документации проекта, базовая структура:\\ |
| **Общая информация**\\ | **Общая информация**\\ | ||
| Текст, посвященный общей информации о проекте, должен находиться непосредственно на странице проекта.\\ | Текст, посвященный общей информации о проекте, должен находиться непосредственно на странице проекта.\\ | ||
| Строка 35: | Строка 46: | ||
| [[:руководство_администратора|Руководство администратора]] - документация, которая помогает администратору / сотруднику компании выполнить настройку системы.\\ | [[:руководство_администратора|Руководство администратора]] - документация, которая помогает администратору / сотруднику компании выполнить настройку системы.\\ | ||
| [[:руководство_тп|Руководство технической поддержки]] - документация, которая доступна сотрудникам технической поддержки компании АГБИС, но недоступна администраторам клиентов.\\ | [[:руководство_тп|Руководство технической поддержки]] - документация, которая доступна сотрудникам технической поддержки компании АГБИС, но недоступна администраторам клиентов.\\ | ||
| - | |||
| - | <code> | ||
| - | В названии страницы не должно быть цифр в начале названия. | ||
| - | В названии страницы обязательно должно фигурировать имя проекта, например [[:Руководство администратора Агбис Клиент|Руководство администратора]].\\ | ||
| - | </code> | ||
| **Пользовательская документация**\\ | **Пользовательская документация**\\ | ||
| Строка 50: | Строка 56: | ||
| Страницы всех документов проекта, ведущие на отдельные страницы, должны вверху страницы содержать ссылку на общую страницу по проекту.\\ | Страницы всех документов проекта, ведущие на отдельные страницы, должны вверху страницы содержать ссылку на общую страницу по проекту.\\ | ||
| </alert> | </alert> | ||
| + | <code> | ||
| + | В названии страниц не должно быть цифр в начале названия. | ||
| + | В названии страниц обязательно должно фигурировать имя проекта, например [[:Руководство администратора Агбис Клиент|Руководство администратора]]. | ||
| + | </code> | ||
| + | |||
| При создании новых проектов можно брать базовый шаблон из [[internal:Базовый шаблон страницы проекта]].\\ | При создании новых проектов можно брать базовый шаблон из [[internal:Базовый шаблон страницы проекта]].\\ | ||
| Строка 81: | Строка 92: | ||
| [[:синтаксис_wiki|Синтаксис Wiki]]\\ | [[:синтаксис_wiki|Синтаксис Wiki]]\\ | ||
| + | [[:drafio_plugin|Пример drawio (диаграммы)]]\\ | ||
| [[:как_создавать_страницы_права_доступа|Как создавать страницы, права доступа]]\\ | [[:как_создавать_страницы_права_доступа|Как создавать страницы, права доступа]]\\ | ||
| [[:изменения_в_документации|Изменения в документации]]\\ | [[:изменения_в_документации|Изменения в документации]]\\ | ||
| - | |||