Jak dokumentujecie wasz kod?
utworzone przez | sty 13, 2021
- Skomentowany kod (doxygen)
- Wyjaśnienie intencji działania metody, czy klasy lub fragmentu kodu, jeśli to konieczne. Pozwala na łatwiejsze zrozumienie co autor miał na myśli i weryfikację, czy aby na pewno tak to działa. Natomiast przy wprowadzaniu zmian, pozwala upewnić się, że nie psujemy zamierzonego zachowania.
- Dokumentacja systemu w repozytorium (sphinx)
- architektura
- koncepcja działania
- podział na komponenty
- główne interfejsy
- dokumentacja techniczna działania filtrów (jakie rodzaje ataków wykrywamy i w jaki sposób)
- model sieci GlaDDoS – jak zachowuje się jako urządzenie sieciowe
- dokumentacja administratora
- dokumentacja ról i uprawnień w systemie
- Changelog – opis zmian w stosunku do poprzedniej wersji:
- Jaki jest biznesowy sens zmian?
- Release notes: jakie zmiany trzeba wykonać ręcznie przy wdrożeniu (np. związane z migracją modelu danych).
- Jakie są zmiany techniczne, istotne z punktu widzenia zespołu?
- Dokumenty analityczne, operacyjne, systemowe (confluence)
- Jakie są zmiany funkcjonalne lub wizualne, odczuwalne przez użytkowników?
- Dokumentacja użytkownika
- Tablica zadań w JIRA
Najnowsze komentarze