Как документировать существующие продукты и их развитие?

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

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

Поэтому я планирую документировать все свои продукты. У меня есть некоторые ключевые моменты, которые я хочу задокументировать, такие как цель продукта, KPI, поток пользователей. Но я понятия не имею, как это делают другие организации?

  1. Как мне начать?
  2. Какие еще важные вещи я должен задокументировать помимо пунктов, упомянутых выше?
  3. Существуют ли обычно используемые шаблоны документов для этого?
  4. Какие инструменты обычно используются для этого?

Большое спасибо!

Как ретроспец ? Если бы мы только знали ответ на этот вопрос...

Ответы (1)

Ради того, чтобы быть прямо вперед, здесь идет.

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

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

  3. Я предлагаю вам использовать вики-подход . Таким образом, вы можете больше сосредоточиться на содержании вашей документации, а не на ее формате. Как я уже говорил: начните сейчас, начните с малого.

  4. Инструменты Wiki , безусловно, моя рекомендация для вас. Существует множество вики-инструментов, которые мы можем использовать. Выберите один и начните документировать.