Back

Рекомендации при создании статей QNote

Последнее изменение 2018-08-04 г.

Общие рекомендации

Рекомендации для информационной статьи

Условно разделитье статью на две части. В первой части, кратко опишите вообще о чем пойдёт дальше. Достаточно будет одного или двух предложений. Если в заголовке статьи всё сказано и больше добавить нечего, то пропустите первую часть. Во второй части описывайте подробности. Если ваша информация имеет каие то перечисления, используйте списки в редакторе статьи. Пишите статью как список дел для себя. Используйте глаголы "Сделать", "Включить" вместо "Сделайте", "Включите".

Рекомендации для статьи - заметки

Это ваш удачный или неудачный опыт который вы хотите сохранить. Здесь важно чтобы материал был хорошо структурирован. Пишите кратко, но в том обьёме чтобы было понятно. Избегайте эмоциональной окраски. Не пишите как было вам трудно или легко. Эта информация не имеет никакого смысла. Не отвлекайтесь от темы. Используйте следующий шаблон при написании статьи:

  • Симптомы
    Опишите с какими симптомами приехала машина. Запишите, что говорил клиент о неиспраности. Так же опишите на что вы обратили внимание при приёме машины до подключения оборудования.
  • Начальные проверки
    Здесь опишите какие проверки были проведены. Всё что здесь не описано будет считаться не проверенным. Проверка которая в этот момент считается само собой разумеещемся, потом, или для дргуих может оказаться неочевидной. В тоже время не нужно пистаь что был подключен сканер если вы приложили список DTC или написли что ошибок нет. Прикрепите список DTC, необходимые параметры Datastream из ScanDoc или другого сканера. Осцилограмму с моторетестера. Если проблема была не решена прикрепите весь датастрим который вы считали из блока. Если проблема решена, то только необходимые параметры. Прикрепление идентфикации поможет потом определить идентичность программного обеспечения ЭБУ. Мы настоятельн рекомендуем это делать.
  • Решение или отсутсвие решения проблемы
    Если проблема была решена, то укажите в чём была причина и как проблема была решена. Если проблема была не решена, укажите это. Может кто то из участников вам подскажет решение или направление решения.