Standard e modello di scrittura dell'articolo

Questo modello descrive gli standard per la scrittura di articoli competenti. Usa gli articoli della knowledge base di Apple come esempio: https://support.apple.com/en-ca/HT207935

Titolo

Il titolo dell'articolo deve riflettere il contenuto degli articoli per un facile riconoscimento e per facilitare la ricerca.

Esempi: "Come si elimina un brano?", "Benvenuto su Anytune iPhone/iPad"

Linee guida

1. Evita di creare articoli duplicati. Cerca attentamente prima di creare.
2. Inizia con "Titolo 2" per i titoli. Il titolo dell'articolo è Titolo 1 e dovrebbe essercene solo uno.
3. Scrivi in maiuscolo i nomi dei prodotti e i nomi dei pulsanti di testo:
   Tocca il pulsante Modifica. Non dare comandi in grassetto.
4. Usa l'immagine della tabella dei pulsanti (svg) con un'altezza di 22 pixel quando il pulsante utilizza un'icona:
   Tocca Ripristina
5. Usa le virgolette per selezionare le opzioni:
   3. Scegli "Canzone accordata" e "E-mail"
6. Per seguire una gerarchia utilizzare:
   Vai a Menu Anytune > File > Esporta configurazione > Esporta su file...
7. Utilizzare elenchi numerati per i passaggi di una procedura.
   I passaggi terminano in un periodo.
8. I titoli delle procedure sono H@ e terminano con due punti. Esempio: "Titolo della procedura:"
9. Quando i passaggi sono diversi per le versioni del prodotto, creare più sezioni con l'intestazione della descrizione 3 intestazioni
10. Usa gli elenchi puntati.
11. Mantenere il contesto del cliente
12. Ricorda il pubblico
13. Non fare riferimento a un cliente
14. Astenersi da abbreviazioni e acronimi
15. Assicurati che tutti i link funzionino

etichette

Includere etichette appropriate con gli articoli. Le etichette influenzano la pertinenza della ricerca degli articoli e rispondono ai risultati dei bot. Possono essere utilizzati anche per creare elenchi di articoli.

Usa una sola parola dove possibile e non usare variazioni della stessa parola. Usa le etichette con parsimonia.
Esempi: macOS, import, bluetooth, ReFrame

Modello

---

---

Riassunto di ciò che questo articolo ti dirà.

Usa l'intestazione 3 per il processo e per distinguere le piattaforme

1. Fasi del processo
2. Clicca il Pulsante di aiuto
3. Scegli "E-mail"
4. Tocca Modifica

Su Mac il processo per questo è

Nota: fornire note in <p class="anytune-note">nota</p>

Avvertenza: fornire note nella <p class="anytune-warning">nota</p>

Enfatizza evidenziando con <p class="anytune-highlight">nota</p>

Ulteriori informazioni (H3)

Comunica all'utente dove si trovano ulteriori informazioni tramite i collegamenti .

---

---

Come correggere i problemi

Quando l'articolo descrive come risolvere un problema, includi queste sezioni

• Problema: Descrivi il problema e cerca di usare le parole del cliente.
• Ambiente: descrivere l'installazione e la configurazione a cui si applica questa correzione (facoltativo)
• Risoluzione: questi sono i passaggi per risolvere
• Causa: quale scenario ha causato o potrebbe aver causato il problema
• Etichette: includi parole che si riferiscono all'articolo in questione per aiutare

Guarda anche

• Formattazione dell'articolo