Как правильно документировать алгоритм с примерами данных?

10

Мне интересно, что должна содержать документация по алгоритму? Не могу найти правильное руководство для подражания. Я имею в виду, чтобы включить

  • краткое изложение алгоритма
  • описание алгоритма
  • блок-схема
  • псевдокоды
  • образец входного набора данных (несколько)
  • выходные данные
  • модульные тесты
  • эксперименты

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

  • Как бы выглядела такая документация? (пример PDF)
  • Что бы вы включили больше в эту документацию?
  • То, что я перечислил, это хорошо, или это должно быть как-то задокументировано иначе?
  • Как вы будете искать в Google такие образцы документации?
Pentium10
источник

Ответы:

4

Еще несколько моментов:

  1. Анализ производительности / эталон с примерами входных данных и сред.
  2. Альтернатива алгоритму (если есть), действительно помогает новым людям и для сравнительного анализа.
  3. Примеры лучших и худших сценариев / входов.

Как бы выглядела такая документация?
Клиентам / пользователям (/ менеджерам?) Не нравится PDF, они считают PPT очень интересными, но в то же время бизнес будет настаивать на PDF. Таким образом, у вас должен быть двухуровневый документ, один в PPT, чтобы просто «объяснить за 20 минут», а другой в PDF, который покрывает мрачные детали игры.

Сурадж Чандран
источник
Также, если доступны альтернативные алгоритмы, вы должны сравнить эффективность обоих алгоритмов.
Какие образцы вы можете показать?
Pentium10