Szablon Komponent projektu

autora Tony Starr, Kierownik ds. projektowania treści @ Atlassian

To narzędzie pozwoli Ci utworzyć bibliotekę dokładnie udokumentowanych komponentów projektu

NAJWAŻNIEJSZE FUNKCJE
Dokumentacja
Wymagania
Baza wiedzy

Kategorie

Projekt
Szablon Strona

Monitorowanie wszystkich komponentów, jakich zespół używa w swoich projektach może stanowić nie lada wyzwanie, zwłaszcza gdy zespół się rozrasta. Szablon komponentów projektu pozwoli Ci udokumentować każdy z nich od podstaw, uwzględniając to, co dany komponent robi, jego budowę, a także specyfikę wyglądu i działania w różnych kontekstach. Zawiera on nawet sekcję na dodatkowe wytyczne, w której można objaśnić właściwe dla komponentu reguły treści, dostępności, mobilności itp. W ten sposób możesz utworzyć całą bibliotekę komponentów od zera!

Jak korzystać z szablonu komponentów projektu

Krok 1. Rozpoczęcie od podstaw

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ą.

Krok 2. Przedstawienie specyfiki

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.

Krok 3. Udokumentowanie porad, wskazówek i najlepszych praktyk

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 wskazówki 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.

Krok 3. Udokumentowanie porad, wskazówek i najlepszych praktyk

Related Templates

Słownik na potrzeby tworzenia treści

Słownik na potrzeby tworzenia treści

Naucz autorów tekstów korzystania z nazw produktów, pojęć branżowych oraz innych treści dzięki przewodnikowi od A do Z.

autora Atlassian
Dowiedz się więcej
Strategia dotycząca treści

Strategia dotycząca treści

Nakreśl strategię dotyczącą treści i uporządkuj kalendarz redakcyjny

autora Atlassian
Dowiedz się więcej
Słownik na potrzeby tworzenia treści

Słownik na potrzeby tworzenia treści

Naucz autorów tekstów korzystania z nazw produktów, pojęć branżowych oraz innych treści dzięki przewodnikowi od A do Z.

autora Atlassian
Dowiedz się więcej
Strategia dotycząca treści

Strategia dotycząca treści

Nakreśl strategię dotyczącą treści i uporządkuj kalendarz redakcyjny

autora Atlassian
Dowiedz się więcej
Raport z rozmowy z klientem

Raport z rozmowy z klientem

Zamień rozmowy z klientem we wnikliwe analizy, korzystając z raportu z rozmowy z klientem.

autora Atlassian
Dowiedz się więcej