documentation:rules
Различия
Показаны различия между двумя версиями страницы.
| Предыдущая версия справа и слеваПредыдущая версияСледующая версия | Предыдущая версия | ||
| documentation:rules [2021/10/07 11:05] – ilya | documentation:rules [2026/05/08 14:32] (текущий) – petrk | ||
|---|---|---|---|
| Строка 1: | Строка 1: | ||
| + | [[: | ||
| + | |||
| ====== Правила написания документации ====== | ====== Правила написания документации ====== | ||
| Строка 4: | Строка 6: | ||
| Все документы требуется составлять по единому стандарту в соответствии с утвержденными шаблонами.\\ | Все документы требуется составлять по единому стандарту в соответствии с утвержденными шаблонами.\\ | ||
| - | Шаблоны для работы и подготовки документации для каждого типа документа можно найти и скачать в КИС, в разделе " | + | Шаблоны для работы и подготовки документации для каждого типа документа можно найти и скачать в КИС, в разделе " |
| Скачать шаблон можно с помощью ссылки " | Скачать шаблон можно с помощью ссылки " | ||
| + | \\ | ||
| Обратите внимание, | Обратите внимание, | ||
| - | Всю работу над документом необходимо производить в файле шаблона, | + | \\ |
| - | Данные которые необходимо изменять для документов каждой подсистемы или модуля отмечены красным. | + | Всю работу над документом необходимо производить в файле шаблона, |
| + | Данные которые необходимо изменять для документов каждой подсистемы или модуля отмечены красным.\\ | ||
| + | \\ | ||
| + | При работе с документами в текстовом редакторе MS Word настоятельно рекомендуется включать обязательное отображение скрытых знаков форматирования (пробелов, | ||
| ===== Оформление технической документации ===== | ===== Оформление технической документации ===== | ||
| Строка 21: | Строка 27: | ||
| Размер шрифта заголовков первого (верхнего) уровня: | Размер шрифта заголовков первого (верхнего) уровня: | ||
| Размер шрифта заголовков второго уровня: | Размер шрифта заголовков второго уровня: | ||
| - | Размер шрифта подписей: | + | Размер шрифта подписей |
| \\ | \\ | ||
| Допускается использование полужирного и курсивного выделений в тексте.\\ | Допускается использование полужирного и курсивного выделений в тексте.\\ | ||
documentation/rules.1633593906.txt.gz · Последнее изменение: — ilya