Zasoby pisania technicznego

Ta strona podsumowuje dodatkowe zasoby pisania technicznego.

Przewodniki stylu redakcyjnego

Przewodnik stylu redakcyjnego określa wytyczne grupy redakcyjnej dotyczące komunikacji. Na przykład, którą z następujących zasad powinna przyjąć Twoja organizacja w odniesieniu do nagłówków?

• Piszemy w nagłówkach zdania (kapitalizujemy tylko pierwsze słowo każdego nagłówka)
• Piszemy w nagłówkach tytuły (kapitalizujemy większość słów w każdym nagłówku)

Nie trać czasu i energii na spieranie się o tego rodzaju kwestie.Zamiast tego, po prostu poproś swoją organizację o przyjęcie konkretnego przewodnika stylu redakcyjnego.Przewodnik stylu redakcyjnego zapewnia zestaw odpowiedzi na pytania dotyczące wyborów związanych z pisaniem. Nie ma znaczenia, że jeden przewodnik stylu redakcyjnego popiera przypadek zdania, a inny preferuje przypadek tytułu. Ważne jest tylko, aby Twoja organizacja przyjęła jeden przewodnik redakcyjny.

Ach, ale który przewodnik redakcyjny? Być może znasz już ogólne przewodniki redakcyjne (takie jak Chicago Manual ofStyle lub University of Oxford StyleGuide).Jednak Twój zespół inżynierów powinien korzystać z przewodnika redakcyjnego wyspecjalizowanego w piśmie technicznym. Zalecamy wybór jednego z następujących przewodników:

• Przewodnik stylu dokumentacji deweloperskiej Google zawiera wytyczne redakcyjne dla wszystkich osób piszących dokumentację deweloperską dla projektów związanych z Google.
• Przewodnik stylu pisania firmy Microsoft zawiera wytyczne dla wszystkich osób piszących dokumentację techniczną.

Nie pisz własnego przewodnika stylu redakcyjnego. Tworzenie i utrzymywanie „domowego” przewodnika stylu redakcyjnego wymaga ogromnych zasobów i powoduje ogromne konflikty. Niektóre organizacje wprowadzają nową terminologię, która nie pojawia się w istniejącym przewodniku stylu redakcyjnego. Gdy tak się stanie, organizacja może wykonać jedną z następujących czynności:

• Zażądać od opiekunów redakcyjnego przewodnika stylu dodania nowych terminów.
• Stworzyć i utrzymywać własny przewodnik użytkowania lub arkusz stylów, który kodyfikuje pisownię i użycie słów dla specjalistycznego słownictwa organizacji.

Możliwości dokumentacji typu open-source