Про документацию

Про документацию

Продолжаю изучать лучшие практики по подготовке документации для использования в нашем продукте ForPeople

Для HR это может быть полезно при разработке учебных курсов, материалов по адаптации и других лонгридов.

Вот что удалось сформулировать для себя:

1.  Кажется, никто из пользователей уже давно не читает инструкции)

2.  Документация для пользователей должна быть как можно более доступна для них (близка к ИТсистеме, а лучше внутри ИТсистемы)

3.  Иногда хочется, конечно, обвесить все подсказками, но подсказок не должно быть слишком много

4.  Наши прекрасные дизайнеры очень правильно подсказывают, что «если непонятно, что делает кнопка, значит, надо переделывать интерфейс»

5.  Что писать в инструкции с подсказками, встроенными в систему – стандартные шаги работы или, наоборот, те, что не очевидны на первый взгляд? Хочется все, но тогда шагов будет слишком много.

6.  В ходе наших внутренних обсуждений еще была классная аналогия про «книгу и фильм» - "чтобы снять фильм не обязательно нужна книга, достаточно только сценария"

7. Материалы для документации есть повсюду: в заметках аналитиков, в ТЗ заказчиков, в описании задач для разработки, в описании кейсов для тестирования, в тонне внутренних чатов, и только потом, собственно, в самой документации.

Продвижение моих познаний в этой области уже есть, но чтобы заработала система, нужно еще немного времени :)

Буду держать в курсе!

Тегом #ForPeople я начала помечать посты про организацию процессов разработки нашего HRTech продукта, по нему можно следить за нашим прогрессом)

Пока есть 2 других поста на эту тему: Описание задач https://t.me/whrdata/1389 и Приоритезация https://t.me/whrdata/1422

#ForPeople