Itqualityassurance
- Jakie są dwa rodzaje dokumentacji?
- Jak zobaczyć dokumentację funkcji w Pycharm?
- Jaka jest dokumentacja systemowa?
Jakie są dwa rodzaje dokumentacji?
Dokumentacja może odnosić się do dwóch różnych rodzajów: produktów i procesów. Dokumentacja produktu opisuje opracowywany produkt i zawiera wytyczne dotyczące wykonywania działań z nim. Z drugiej strony dokumentacja procesu dotyczy wszystkich materiałów utworzonych podczas rozwoju.
Jak zobaczyć dokumentację funkcji w Pycharm?
Naciśnij Ctrl+Q lub wybierz Widok | Szybkie wyszukiwanie dokumentacji w menu głównym. W oknie dialogowym Ustawienia (Ctrl+Alt+S), przejdź do edytora | Ogólne | Ukończenie kodu. Strona zakończenia kodu otwiera się. Wybierz pole wyboru Pokaż wyskakujące okienko dokumentacji i określ czas upływający.
Jaka jest dokumentacja systemowa?
Dokumentacja systemu reprezentuje dokumenty opisujące sam system i jego części. Zawiera dokumenty wymagań, decyzje projektowe, opisy architektury, kod źródłowy programu i często zadawane pytania. Dokumentacja użytkownika obejmuje instrukcje przygotowywane głównie dla użytkowników końcowych administratorów produktu i systemu.
