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