Docs Ghid de stil
Style Guide Rule #1: Follow the Style Guide. Rule #2: See previous rule.
TL;DR? Am don't face asta aici!
Nu există care rezumă această pagină. Ghid de stil trebuie să fie citite în totalitate și urmat. Se abat de la stilul ghid trebuie să fie adoptată după discuții, permițând Ghid de stil pentru a modifica după cum este necesar pentru scopuri practice.
Când cu ajutorul unui ghid de stil, documentația portal va avea o singură voce pentru cititor. Fără un ghid de stil, cititorii nostri vor avea pentru a regla așteptările lor pentru fiecare document, făcând o mai mică de ideal experienta cu posibile, inutilă de erori si omisiuni.
Liniile Directoare Generale
Încercați să folosiți cât mai puține cuvinte, rămânând suficient de descriptiv în instrucțiunile dvs.
Fi specifice și nu omiteți informații importante sau considerente care vor beneficia de decizie informată de cititor
Pentru acțiune utilizator instrucțiuni, Puneți key words În bold (exemplu : Deschis Chrome, selectați câmpul de adresă din partea de sus și completați www.ether1.org)
Utilizați italic text pentru nume și scurte referințelor/cotații
Utilizare ca multe capturi de ecran posibil să vă ajute informații și dovetail vizual cu acțiunea instrucțiuni informații în bold (vezi mai sus orientare)
Utilizați codul triplu tag-uri pentru a distinge terminal comenzi, editor de text conținutul și blocurile de cod
Utilizați cod unic tag-uri pentru a distinge nimic să găsiți trebuie să iasă în evidență
Utilizarea cilindrilor-cotații pentru note, comentarii și îndelungat de cotații/referințelor
Titluri, Rubricile & Rezumate
Fiecare non-tesutului conjunctiv (daca utilizate ca primul cuvânt în titlu) cuvântul din titlul este imobilizata (exemplu : Este o Probă Titlul)
Fiecare document începe cu un sumar, introducere sau o descriere secțiunea care explică fundalului din spatele documentului si/sau orice takeaways majore. Majoritatea oamenilor nu va utiliza această secțiune, avem nevoie pentru a o face bine.
Rubricile începe la #/prima nivel.
Limită până-vă conținutul în logic al 2lea/al 3-lea nivel rubricile pentru a ajuta cititorul de naviga prin conținutul și găsi informații utile.
Link-uri
La raportarea această documentație portal, include întotdeauna pe link pentru ușurință în utilizare
Utilizați buna descrieri pentru dvs. link-uri în general
Atunci când există dubii, link-l pentru cititor's beneficieze
(Traducere oferită de @EthanCS#0853)
Last updated