Szablon komponentów projektu

Zanim przejdziesz do szczegółowego opisu specyfiki komponentu, musisz przedstawić podstawowe informacje. Rozpocznij od wypełnienia pól w sekcji Podstawowe informacje o komponencie: nadaj komponentowi nazwę, opisz, co robi, oraz zamieść schemat jego budowy wraz z ponumerowanymi objaśnieniami. W oparciu o nie można utworzyć klucz i zdefiniować każdy element budowy komponentu. Ta sekcja ma na celu uświadomienie użytkownikom komponentu, w jaki sposób wszystkie jego elementy współdziałają ze sobą.

W tym miejscu zaczniesz poznawać różne sposoby wykorzystania komponentu w projektach bardziej rozbudowanych funkcji. Opisz sposób użycia komponentu, uwzględniając jego cel w projekcie jako całości. Następnie omów, jak on wygląda i działa w różnych kontekstach. Do przedstawienia różnych wariantów wykorzystaj aktywny kod z repozytorium swojego systemu projektowania. Na końcu opisz styl wizualny komponentu. Pamiętaj o dodaniu przykładów zaleceń i zakazów.

Każdy komponent ma swoje wady. Zapisz je w sekcji Dodatkowe wskazówki. Zacznij od następujących kwestii: czy istnieją reguły interpunkcji właściwe dla tego komponentu? Co z etykietami standardowymi? Zapisz odpowiedzi, a także wszelkie inne potencjalne problemy z dostępnością właściwe dla komponentu oraz porady dotyczące jego zastosowania w środowiskach mobilnych. Jeśli istnieją najlepsze praktyki dotyczące stosowania komponentu przyjęte jako standard w branży, je również uwzględnij. Na końcu dodaj łącza do wszelkich powiązanych komponentów lub wzorców.