Различия

Показаны различия между двумя версиями страницы.

--- pub:instrukcija_po_napisaniju_instrukcij_v_wiki [2024/12/03 08:48] – создано konstantin.zamalevsky
+++ pub:instrukcija_po_napisaniju_instrukcij_v_wiki [2025/01/21 14:20] (текущий) – sharixadmin
@@ Строка 1: / Строка 1: @@
 ====== Инструкция по написанию инструкции ======
 ==== Краткое описание ====
-Этот документ дает плезные знания по написанию более краткой и понятной для людей инструкции.
+Этот документ представляет собой рекомендации по созданию документов с инструкциями. Он составлен для практикантов и начинающих разработчиков и призван помочь сориентироваться при написании инструкции таким образом, чтобы конечный результат получился понятным для остальных.
-  * **инструкция по написанию инструкции
+  * **Начальный уровень знаний:** базовое владение ПК, навыки текстовой разметки приветствуются
-  * **Для:инструкция написанна для начинающих людей
-  * **Начальный уровень знаний:** нужно знать основы языка программирования
 ===== Описание инструкции =====
-Инструкция — это документ, который содержит подробные указания, рекомендации или правила по выполнению определённых действий, процессов, процедур или задач.
+Инструкция — это документ, который содержит подробные указания, рекомендации или правила по выполнению определённых действий, процессов, процедур или задач. Очень важно, чтобы этот документ был максимально информативным.
+Рекомендуется придерживаться следующего шаблона: [[Шаблон написания инструкции]]
 ===== Описание хода работы с написанием инструкции  =====
-Прописание плана,Определение аудитории.Написание простым и понятным языком,Сбор примеров и кейсов.Создание визуального сопровождения,Проверка инструкции.Тестирование и запуск
+  * Сформулируйте цель документа. Подумайте над тем, кто будет им пользоваться. Какие исходные данные необходимы этим людям для того, чтобы успешно воспользоваться инструкцией?
+  * Обычно инструкция описывает использование того или иного инструмента или той или иной задачи. Определитесь с тем, что конкретно должно быть в документе.
+  * Составьте план. Его логичнее всего использовать как систему подзаголовков в разделе "Описание хода работы". Если инструкция - описание работы с инструментом - то план может представлять из себя перечень актуального функционала для аудитории в рамках их задач в компании. Если инструкция подразумевает решение задачи - то система подзаголовков есть последовательность основных шагов, которые в дальнейшем будут расписаны более подробно.
+  * Заполните всю информацию по подразделам. Это можно делать последовательно и постепенно. Можно даже для начала сделать набросок, описав идею в общих чертах, позже постепенно расписывая детали.
+  * Не ленитесь добавлять иллюстрации, фрагменты кода, команды и т.п. В верхней части страницы при ее редактировании есть ссылка на справочную страницу и playground. Используйте их для создания адекватного форматирования. Чаще используйте предпросмотр. Не бойтесь сохранять промежуточный итог правок.
+  * Приветствуется описание сводки изменений - это аналог commit message при написании кода. В случае внесения множественных правок на странице это значительно облегчит дальнейшую работу.
 ===== Описание особенностей и ограничений =====
-Назначение: инструкции закрепляют правила работы предприятия и обязанности работников, делают рабочий процесс понятным и предсказуемым.
+Ниже приведены некоторые полезные рекомендации, которые можно учитывать при составлении инструкций.
-Типовая структура: заголовок, общие положения, основной текст и приложение. В заголовке отражают основное содержание и назначение документа. В общих положениях указывают цель, область применения и порядок использования инструкции. В основном тексте пишут от третьего лица или в безличной форме. В приложении указывают законодательные акты, на основе которых разработали инструкцию, а также сертификаты качества продукции и прочие необходимые документы.
-Утверждение: инструкцию утверждает и подписывает руководитель предприятия или подразделения, для которого её разработали.
-Двусмысленные формулировки: при составлении инструкции не допускают двусмысленных формулировок — все обязанности прописывают чётко, понятно и подробно, не ограничиваясь общими фразами.
-===== Дополнительные источники =====
+  * При описании назначения: инструкции обычно закрепляют правила работы предприятия и обязанности работников, делают рабочий процесс понятным и предсказуемым. Инструкция должна быть применима. Обязательно попробуйте дать ее коллеге на проверку.
-«Инструкции по применению потребительской продукции». Стандарт содержит методические указания по общим принципам и рекомендациям по оформлению и составлению инструкций по применению продукции.
+  * В основном тексте пишут от третьего лица или в безличной форме. Приветствуются ссылки на иные документы и инструкции. Не приветствуется перепечатка и дублирование информации. Если необходимо продублировать текст другой страницы полностью - для этого есть соответствующий модуль Docuwiki, он доступен в данной инсталляции, для использования его обратитесь к инструкции.
+  * Полезным будет указать дополнительные источники - более полные инструкции, документацию, ссылки на стандарты, законы и т.п., если документ является обще ознакомительным.
+  * Любая инструкция после публикации на данном ресурсе может быть откорректирована руководителем в соответствии с актуальным рабочим процессом. Так как данный портал также является базой знаний, тут могут быть опубликованы и инструкции, которые пока находятся в разработке. Применяйте такие инструкции с осторожностью и предусмотрительностью. Однако не бойтесь создавать новые документы. Их появление значительно упрощает передачу знаний и процесс работы в целом.
+  * Постарайтесь исключать двусмысленные формулировки, а термины, специфичные для компании лучше расшифровывать, чтобы избежать возможных разночтений.
+===== Дополнительные источники =====
+[[wiki:syntax|Справочник по форматированию - Formatting Syntax]]