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

Материал из ALT Linux Wiki
< Участник:Petr-akhlamov
Версия от 10:42, 1 мая 2024; Petr-akhlamov (обсуждение | вклад) (Новая страница: «{{stub}} На данной странице я хочу расписать тезисы по написанию статей для пользователей по своим наблюдениям: *не перепрыгивайте через ступеньки: если вы что-то знаете хорошо, не факт что читатель статьи знает то же. То что, возможно, для вас пустяки, для д...»)
(разн.) ← Предыдущая версия | Текущая версия (разн.) | Следующая версия → (разн.)
Stub.png
Данная страница находится в разработке.
Эта страница ещё не закончена. Информация, представленная здесь, может оказаться неполной или неверной.

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

  • не перепрыгивайте через ступеньки: если вы что-то знаете хорошо, не факт что читатель статьи знает то же. То что, возможно, для вас пустяки, для другого читателя может быть темный лес. Старайтесь прописывать шаги как можно подробней
  • используйте шаблон Notes: делайте заметки для пользователя:
    • указывающие на что стоит обратить внимание в данном разделе
    • подтверждающие указанные значения, если вы предполагаете что у пользователя, как и у вас, могут возникнуть вопросы
    • расписывающие указанные в строках значения
  • Расписывайте, по возможности, возможные ошибки и их решения
  • Если описывается какая-то конфигурация из множества файлов, распишите их расположение с помощью tree и укажите их место