Resurse de tehnoredactare

Această pagină rezumă resurse suplimentare de tehnoredactare.

Ghiduri de stil editorial

Un ghid de stil editorial definește liniile directoare ale unui grup editorial pentru comunicare. De exemplu, care dintre următoarele reguli ar trebui să adopte organizația dvs. pentru titluri?

• Puneți titlurile în cazul propozițiilor (scrieți cu majuscule doar primul cuvânt al fiecărui titlu)
• Puneți titlurile în cazul titlurilor (scrieți cu majuscule majoritatea cuvintelor din fiecare titlu)

Nu pierdeți timp și energie certându-vă pe marginea acestor tipuri de întrebări.În schimb, cereți pur și simplu organizației dvs. să adopte un anumit ghid de stil editorial. un ghid de stil editorial oferă un set de răspunsuri la întrebări despre alegerile de redactare. Nu contează faptul că un ghid de stil editorialaduce în discuție cazul propoziției și altul preferă cazul titlului. Contează doar ca organizația dvs. să adopte un singur ghid de stil editorial.

Ah, dar care ghid de stil editorial?Este posibil să fiți deja familiarizat cu ghidurile de stil editorial de uz general (cum ar fi Chicago Manual ofStyle sau University of Oxford StyleGuide).Cu toate acestea, echipa dvs. de ingineri ar trebui să folosească un ghid de stil editorial specializat în redactarea tehnică. Vă recomandăm să alegețiunul dintre următoarele:

• Ghidul de stil pentru documentația dezvoltatorilor Google oferă ghiduri editoriale pentru oricine scrie documentație pentru dezvoltatori pentru proiecte legate de Google.
• Ghidul de stil de scriere Microsoft oferă ghiduri pentru oricine scrie documentație tehnică.

Nu vă scrieți propriul ghid de stil editorial. Crearea și menținerea unui ghid de stil editorial „al casei „necesită resurse enorme și provoacă conflicte enorme. Acestea fiind spuse, unele organizații inventează o terminologie nouă care nu apare într-un ghid de stil editorial existent. Când se întâmplă acest lucru, organizația poate face oricare dintre următoarele:

• Solicitați administratorilor unui ghid de stil editorial să adauge noii termeni.
• Creați și mențineți propriul ghid de utilizare sau foaie de stil care codifică ortografia și utilizările cuvintelor pentru vocabularul specializat al organizației dumneavoastră.

Oportunități de documentare cu sursă deschisă

.