Як правильно документувати алгоритм із зразковими даними?


10

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

  • підсумок алгоритму
  • опис алгоритму
  • блок-схеми
  • псевдокоди
  • вибірки набору вхідних даних (кілька)
  • вихідні дані
  • одиничні тести
  • експерименти

Клієнт просить таку документацію: Підтримувати довіру до власних номерів, а також описати наш процес потенційним клієнтам, щоб вони знали, що ми вживаємо заходів для перевірки та перевірки наших розрахунків.

  • Як виглядатиме така документація? (приклад PDF)
  • Що б ви більше включили в цю документацію?
  • Що я перерахував, це добре, чи це має бути якось по-різному документовано?
  • Як би ви шукали в Google такі зразки документації?

Відповіді:


4

Ще кілька пунктів:

  1. Аналіз продуктивності / орієнтир з вибірками входів та середовищ.
  2. Альтернатива алгоритму (якщо він існує) справді допомагає новим людям та для порівняльного аналізу.
  3. Приклади найкращих та найгірших сценаріїв / входів.

Як виглядатиме така документація?
Cusotmers / Користувачі (/ Менеджери?) Не люблять PDF, вони вважають PPT дуже цікавими, хоча бізнес одночасно наполягає на PDF. Отже, у вас повинен бути дворівневий документ, один у PPT просто для того, щоб «пояснити за 20 хвилин», а інший у форматі PDF, який висвітлює деталі гри.


Крім того, якщо є альтернативний Algos, ви повинні порівняти ефективність обох Algos.

Будь-які зразки ви можете показати?
Pentium10
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.