Мне интересно, что должна содержать документация по алгоритму? Не могу найти правильное руководство для подражания. Я имею в виду, чтобы включить
- краткое изложение алгоритма
- описание алгоритма
- блок-схема
- псевдокоды
- образец входного набора данных (несколько)
- выходные данные
- модульные тесты
- эксперименты
Клиент запрашивает такую документацию, чтобы: сохранять уверенность в собственных цифрах, а также описывать наш процесс для потенциальных клиентов, чтобы они знали, что мы предпринимаем шаги для проверки и проверки наших расчетов.
- Как бы выглядела такая документация? (пример PDF)
- Что бы вы включили больше в эту документацию?
- То, что я перечислил, это хорошо, или это должно быть как-то задокументировано иначе?
- Как вы будете искать в Google такие образцы документации?
java
php
algorithms
documentation
sql
Pentium10
источник
источник