Как устроен этот центр помощи

Две вещи в этом центре помощи достаточно необычны, чтобы их объяснить.

Мы документируем то, что приложение делает, а не то, что оно должно делать

Несколько статей здесь прямо говорят, что возможность отсутствует, сделана наполовину или заявлена где-то ещё в продукте, но на деле недоступна. Кнопка экспорта данных. Переключатели уведомлений. Раздел рефералов.

Так задумано. Центр помощи, описывающий задуманный продукт вместо выпущенного, хуже, чем его отсутствие, потому что он отправляет вас искать элемент управления, которого нет, и оставляет с ощущением, что проблема в вас.

Поэтому там, где есть пробел, статья так и говорит, объясняет, что происходит вместо этого, и даёт способ получить нужный результат вручную. Такие статьи собраны на странице известных пробелов.

Эти статьи живут рядом с кодом

Статьи помощи пишутся в том же репозитории, что и приложение, и выпускаются вместе с ним. Это деталь реализации, до которой вам не должно быть дела, — кроме одного следствия: когда кнопку переименовывают, описывающая её статья меняется в той же правке. Это самый дешёвый известный нам способ не дать документации сползти в вымысел.

Каждая статья несёт дату последней проверки.

Чего мы писать не будем

Мы не будем описывать возможность, которой ещё нет, как бы близко она ни была. Если её нет в продукте, её либо нет и здесь, либо её отсутствие явно отмечено.

Мы не будем называть даты выпуска. Нигде здесь не написано «скоро» с указанием месяца, потому что пропущенная дата хуже, чем никакой.

Мы не будем разводить объём. Если ответ занимает один абзац, статья состоит из одного абзаца.

Если статья неверна

Скажите нам. В конце каждой статьи есть элемент «Было полезно?», и ответ «нет» открывает поле, где можно объяснить почему. Это попадает туда же, куда и сообщение в поддержку, и это читает человек.

Если статья противоречит приложению, право приложение, а статья — это ошибка. Такие исправляются быстро.