Мені цікаво, що повинна містити документація щодо алгоритму? Не вдається знайти правильну інструкцію, яку слід дотримуватися. Я маю на увазі включити
- підсумок алгоритму
- опис алгоритму
- блок-схеми
- псевдокоди
- вибірки набору вхідних даних (кілька)
- вихідні дані
- одиничні тести
- експерименти
Клієнт просить таку документацію: Підтримувати довіру до власних номерів, а також описати наш процес потенційним клієнтам, щоб вони знали, що ми вживаємо заходів для перевірки та перевірки наших розрахунків.
- Як виглядатиме така документація? (приклад PDF)
- Що б ви більше включили в цю документацію?
- Що я перерахував, це добре, чи це має бути якось по-різному документовано?
- Як би ви шукали в Google такі зразки документації?