2875
правок
Изменения
м
→Наполнение
= Наполнение =
#После заголовка необходимо описать описывайте что это, затем необходимо рассказать рассказывайте о задачах, которые решает функционал, если из их описания это не понятно, а затем об опыте использования или о полезных "фишках".
#Наполнение должно быть актуальным и отражать реальное положение дел, на данный момент. Если есть информация, в которой нет уверенности или требуется разъяснение, то лучше уточнить.
#Если же актуальной информации нет, то оставьтераздел пустым, до момента появления информации (оставьте запись, что раздел на этапе написания).
#Обратите внимание, что текст будет прочитан обычными людьми, не обладающими профессиональными навыками в программировании или других прикладных дисциплинах, поэтому следует использовать максимально понятный вид изложения.
#Не нужно каждый раз делать ссылку на информацию относительно элементов интерфейса (например: основное меню, вкладки, таблицы и подобное). Данное ограничение не касается статей и разделов статей, которые помогают лучше понять работу той или иной функции программы.
#Если в тексте содержатся слова, требующие детального описания, то необходимо добавить добавляйте их в раздел «Терминология» и сделать ссылку в основной статье. Вы можете давать внешние ссылки на Википедию, в случае, когда описание подходит под задачи и не требует уточнения.
#В случае, если раздел статьи получается слишком объемным, то разбейте его на подразделы, если получается много подразделов, то имеет смысл создать отдельную статью.
#Чтобы не описывать информацию, данную ранее или описанную в других статьях – просто укажите на данную информацию [[Регламент#Наполнение |Ссылку]]. [https://ru.wikipedia.org/wiki/Википедия:Ссылка_раздел Статья о ссылках].
#Если требуется показать пользователю расположение функции в программе, то следует использовать оформление следующего вида: "Справочники" -> "Переменные" -> "Сотрудники" -> "Статус курьера по умолчанию:".
#Запрещается использование слова "можно", "необходимо".
#Если требуется показать пользователю расположение переменной, то необходимо использовать используйте следующее оформление: <mparam code="LetterStates/>. Чтобы посмотреть название переменной в программе необходимо использовать , используйте сочетание клавиш "CTRL"+"ALT"+"P".#Информацию по полям в программе необходимо оформлять оформляйте следующим образом:
##Описание поля должно начинаться с новой строки, с символа точки-списка (*).
##Не все поля в программе следует заполнять, поэтому изначальная формулировка, используемая для перехода к информации должна быть нейтральной. К примеру: "Рассмотрим карточку" или "В карточке присутствуют следующие поля" и т.д..
