мета-данные страницы
Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
документация_агбис [02.09.2021 20:21] admin |
документация_агбис [02.09.2021 20:22] (текущий) |
||
|---|---|---|---|
| Строка 18: | Строка 18: | ||
| ===== Требования по содержанию для клиентов ===== | ===== Требования по содержанию для клиентов ===== | ||
| - | 1. Текст не должен быть перегружен техническими терминами | + | 1. Текст не должен быть перегружен техническими терминами.\\ |
| - | 2. Не забывать про визуализацию (схемы, скриншоты) | + | 2. Не забывать про визуализацию (схемы, скриншоты).\\ |
| - | 3. Текст должен быть разбит на абзацы. Крупные блоки должны иметь заголовок. | + | 3. Текст должен быть разбит на абзацы. Крупные блоки должны иметь заголовок.\\ |
| - | 4. Крупные не связанные друг с другом блоки должны быть разными файлами. Например, не должно быть на одной странице настройка функции и ее использование в работе. При этом хорошо иметь файл с содержанием, то есть ссылками на все отдельные файлы относящиеся к теме. | + | 4. Крупные не связанные друг с другом блоки должны быть разными файлами. Например, не должно быть на одной странице настройка функции и ее использование в работе. При этом хорошо иметь файл с содержанием, то есть ссылками на все отдельные файлы относящиеся к теме.\\ |
| - | 5. Не дублировать материал, если что-то уже описано, то давать ссылку. | + | 5. Не дублировать материал, если что-то уже описано, то давать ссылку.\\ |
| ===== Требования к стилистике ===== | ===== Требования к стилистике ===== | ||
| - | 1. Текст должен быть написан от 3 лица. Например "Необходимо открыть локальные настройки Агбис Химчистки и ...". То есть ПЛОХО написать "Открываем настройки" и уж тем более "Открываешь настройки". | + | 1. Текст должен быть написан от 3 лица. Например "Необходимо открыть локальные настройки Агбис Химчистки и ...". То есть ПЛОХО написать "Открываем настройки" и уж тем более "Открываешь настройки".\\ |
| - | 2. В одном предложении одинаковые слова нужно заменять синонимами. Например, "Нужно, необходимо, требуется". | + | 2. В одном предложении одинаковые слова нужно заменять синонимами. Например, "Нужно, необходимо, требуется".\\ |
| ===== Документация проекта ===== | ===== Документация проекта ===== | ||