Простой #рецепт как делать полезную документацию на основе сценариев:

1. Определиться с адресатами документации - кто, зачем и как будет её использовать. Наивно думать, что пользователям, администраторам и, скажем, продавцам программного продукта нужен один и тот же документ. Это будут разные документы и по структуре, и по содержанию. Хотя, конечно, в них могут быть общие части.

2. Для каждого адресата определить ключевые вопросы, ответы на которые он будет искать в документации. Так, пользователи обычно используют документацию, что понять как с помощью вашего продукта сделать что-то полезное. Простое перечисление функций продукта тут мало помогает. Это прекрасно, что в вашей системе есть 100500 разных функций. Как мне документ создать и распечатать?

3. Составить структуру документа на основе выявленных вопросов и постепенно наполнять документ по этой структуре. Каждый заполненный раздел увеличивает количество ответов на вопросы и тем самым увеличивает полезность документа. И не стоит даже пытаться покрыть документацией все возможные детали - это долго, сложно и невозможно поддерживать.

#документация