Участник:Petr-akhlamov/Советы по написанию статей

На данной странице я хочу расписать тезисы по написанию статей для пользователей по своим наблюдениям:

• не перепрыгивайте через ступеньки: если вы что-то знаете хорошо, не факт что читатель статьи знает то же. То что, возможно, для вас пустяки, для другого читателя может быть темный лес. Старайтесь прописывать шаги как можно подробней
• используйте шаблон Notes: делайте заметки для пользователя:
  • указывающие на что стоит обратить внимание в данном разделе
    • Пример: NetInstall_start#Настраиваем_DHCP-сервер
  • подтверждающие указанные значения, если вы предполагаете что у пользователя, как и у вас, могут возникнуть вопросы
    • Пример: NetInstall_start#Настройка_установки_в_Legacy
  • расписывающие указанные в строках значения
    • Пример: NetInstall_start#Настройка_установки_в_UEFI
• Расписывайте, по возможности, возможные ошибки и их решения
  • Пример: NetInstall_start#Ошибки
• Если описывается какая-то конфигурация из множества файлов, распишите их расположение с помощью tree и укажите их место
  • Пример:
    • NetInstall_start#Файловая_часть
    • Сетевой_мост#Что у нас по итогу
    • Создание_собственного_репозитория
    • Сборка_пакетов_start
• Если расписывается настройка сервера, сборки и пр. опишите в Notes значения, которые будут использоваться в статье для примера, чтобы пользователь мог понять что на что ему заменять
  • Пример:
    • PVE_start#Установка
    • Сборка_пакетов_start
    • SambaAD_start#Установка