Close

Categorie

Modello dei componenti di progettazione

scritto da Tony Starr, Lead Content Designer @ Atlassian

Crea una libreria di componenti della progettazione accuratamente documentati

Usa modello
Modello dei componenti di progettazione

Tenere traccia di tutti i componenti utilizzati nei progetti dal team può essere complesso, soprattutto se il team è in crescita. Il modello dei componenti di progettazione ti aiuta a documentare ciascun componente, dagli elementi di base (funzioni e anatomia) alle specifiche (aspetto e prestazioni in contesti diversi). È disponibile persino una sezione per le indicazioni aggiuntive, in cui puoi illustrare le regole specifiche del componente relative a contenuti, accessibilità, dispositivi mobili e molto altro. Crea una libreria dei componenti da zero!

Come usare questo il modello componente di progettazione

Passaggio 1. Inizia dagli elementi di base

Prima di esaminare nei dettagli le specifiche del componente, occorre definirne gli elementi di base. Inizia compilando le righe in Elementi di base dei componenti: assegna un nome al componente, descrivine le funzioni e carica un diagramma della sua anatomia con callout numerati. Utilizza questi callout per creare una chiave e definire ciascun elemento dell'anatomia del componente. Lo scopo di questa sezione consiste nel fornire alle persone che utilizzano il componente un quadro generale del suo funzionamento.

Fase 2. Esponi le specifiche

Qui puoi iniziare a descrivere i diversi modi di utilizzo di un componente all'interno dei progetti nell'ambito di una funzionalità più ampia. Descrivi in che modo viene utilizzato il componente, incluso il suo scopo all'interno del progetto nel suo insieme e passa quindi a illustrarne l'aspetto e il comportamento in contesti diversi. Utilizza il codice in tempo reale dal repository del sistema di progettazione per visualizzare le diverse varianti. Infine, descrivi lo stile visivo del componente. Accertati di includere esempi di cosa fare e cosa non fare.

Fase 3. Documenta suggerimenti, trucchi e best practice

Ogni componente ha le sue peculiarità. Annotale in Linee guida aggiuntive. Inizia dai contenuti: vi sono delle regole di punteggiatura specifiche per questo componente? Delle etichette standard? Annotale insieme ai problemi di accessibilità e ai suggerimenti specifici del componente relativi alla sua applicazione negli ambienti mobili. Se vi sono delle best practice standard del settore sull'utilizzo del componente, riportale qui. Infine, aggiungi dei link a eventuali schemi o componenti correlati.

Fase 3. Documenta suggerimenti, trucchi e best practice
Atlassian

Tony Starr

Lead Content Designer @ Atlassian


Tony è un Lead Content Designer di Atlassian. È un tecnico multidisciplinare e un content writer che adora fissare degli standard e spingersi oltre i limiti delle guide di stile redazionali.

  • Glossario per la progettazione dei contenuti

    Atlassian

    Glossario per la progettazione dei contenuti

    Insegna agli autori come usare i nomi dei prodotti, i termini di settore e altri contenuti con una guida dalla A alla Z.

    Usa modello Scopri di più
  • Strategia dei contenuti

    Atlassian

    Strategia dei contenuti

    Crea un piano strategico per i contenuti e organizza il tuo calendario editoriale.

    Usa modello Scopri di più
  • Report su intervista con il cliente

    Atlassian

    Report su intervista con il cliente

    Trasforma le interviste con i clienti in informazioni utili con il report sull'intervista con il cliente.

    Usa modello Scopri di più