Wikiprojekt:Informatyka/Zalecenia edycyjne - Wzorce projektowe

Poniżej znajdują się zalecenia edycyjne, które powinny być stosowane podczas tworzenia oraz edycji artykułów o wzorcach projektowych.

Sekcje artykułu

Wstęp

Standardowo jest to pierwsza sekcja artykułu. Zaczyna się od nazwy wzorca napisanej pogrubioną czcionką. Zawiera podstawowe informacje o wzorcu: czym jest, do jakiej grupy wzorców należy oraz jakie są jego podstawowe zadania. Warto zwrócić uwagę na to, żeby wstęp nie był napisany zbyt enigmatycznie i nie opisywał wzorca zbyt szczegółowo. Od tego są następne sekcje.

Przykładowe zastosowanie

Po wstępie następuje pierwsza wydzielona sekcja. Jak nazwa wskazuje, powinna opisywać dwa bądź trzy przykładowe (ale rzeczywiste) zastosowania opisywanego wzorca projektowego. Osoba tworząca artykuł (lub rozbudowująca tą sekcję) powinna zwrócić uwagę na to, aby przykładów nie było za dużo. Trzy przykłady absolutnie wystarczą, aby pokazać czytelnikowi zastosowanie wzorca. Jeżeli istnieją publikacje potwierdzające zastosowanie wzorca w jakimś większym projekcie, warto dodać informacje o nich w tej sekcji.

Struktura wzorca

Ta sekcja powinna zawierać informacje o klasach i obiektach, jakie są używane we wzorcu oraz opisywać sposób komunikacji pomiędzy nimi. Tutaj należy także umieszczać diagram klas (ewentualnie inne diagramy) wzorca.

Konsekwencje stosowania

Ta sekcja opisuje plusy oraz minusy stosowania wzorca. Ponieważ sekcja ta jest szczególnie podatna na OR, powinno się w niej opisywać tylko te plusy i minusy, które zostały zwarte w zewnętrznych publikacjach.

Podobne wzorce

Tutaj prezentujemy informacje o podobnych wzorcach.

Przykłady

Tutaj umieszczamy odsyłacz do odpowiedniej strony na Wikiźródłach, gdzie umieszczone są przykładowe implementacje wzorca.

Zobacz też

Tutaj wstawiamy linki wewnętrzne do ciekawych artykułów powiązanych ze wzorcem.

Przypisy

Sekcje tę tworzymy za pomocą szablonu Szablon:Przypisy - tylko i wyłącznie, jeżeli istnieje potrzeba jej tworzenia.

Bibliografia

Pozycje bibliograficzne jakie zostały użyte do stworzenia artykułu. Jednak tylko takie, jakie nie zostały jeszcze wymienione w przypisach. Zaleca się jednak uźródławianie artykułu przypisami - ułatwia to jego weryfikację.

Linki zewnętrzne

Tutaj wstawiamy odsyłacze do ciekawych materiałów umieszczonych poza Wikipedią, uzupełniających treść tworzonego artykułu.

Informacje dodatkowe

• jeśli opisywany wzorzec został wprowadzony przez książkę Design Patterns autorstwa Gangu Czworga, na dole artykułu należy umieścić szablon Wzorce projektowe generujący menu nawigacyjne między poszczególnymi wzorcami
• należy zadbać o poprawną kategoryzację artykułu. Dla wzorców projektowych odpowiednia jest Kategoria:Wzorce projektowe
• należy także dodać interwiki
• przykład zastosowania powyższych zaleceń znajduje się w artykule Budowniczy (wzorzec projektowy)