Zastanawiam się, co powinna zawierać dokumentacja algorytmu? Nie można znaleźć właściwej wytycznej do naśladowania. Mam na myśli to
- podsumowanie algorytmu
- opis algorytmu
- schematy blokowe
- pseudo kody
- przykładowy zestaw danych wejściowych (wiele)
- dane wyjściowe
- testy jednostkowe
- eksperymenty
Klient prosi o taką dokumentację, aby: Utrzymać zaufanie do własnych numerów, a także opisać nasz proces potencjalnym klientom, aby wiedzieli, że podejmujemy kroki w celu sprawdzenia i weryfikacji naszych obliczeń.
- Jak wyglądałaby taka dokumentacja? (przykład PDF)
- Co byś dodał więcej w tej dokumentacji?
- To, co wyliczyłem, jest tak dobre, czy też powinno to być jakoś inaczej udokumentowane?
- Jak wyszukiwałbyś w Google próbki dokumentacji?
java
php
algorithms
documentation
sql
Pentium10
źródło
źródło