podstawowe zasady pisania technicznego

co jakiś czas musimy ponownie przyjrzeć się podstawowym zasadom pisania technicznego. Odkąd zaczęliśmy w 1997 roku, podstawowe zasady pisania technicznego pozostają takie same, nawet gdy zmieniają się sposoby komunikacji.

cel i publiczność

przed rozpoczęciem każdego nowego projektu pisania, pisarz techniczny musi przeanalizować cel dokumentu i zidentyfikować jego zamierzoną grupę odbiorców. Pisarz musi zapytać:

• kto przeczyta dokumentację?
• jakie są ich uprzedzenia?
• jakie mam obowiązki przy przekazywaniu informacji odbiorcom?

Przewodnik po stylach

pisarze techniczni często używają przewodnika po stylach firmy, jeśli jest dostępny, aby upewnić się, że ich dokumentacja ma uporządkowany wzorzec. Przewodnik po stylach (taki jak AP Stylebook) zawiera wskazówki dotyczące wyglądu dokumentu, języka, którego używa i sposobu ułożenia pomysłów. Organizacja ta zapewnia ciągłość dokumentu lub serii dokumentów, dzięki czemu odbiorcy mogą łatwo zrozumieć informacje. Na przykład pisarz techniczny może dokumentować proces chronologicznie, zgodnie z instrukcją stylu. Bez tej struktury czytelnik byłby zdezorientowany i nie byłby w stanie śledzić procesu. Przewodniki po stylach sprawiają, że pisanie jest bardziej spójne i czytelne.

styl pisania

pisarze techniczni zmieniają swój styl pisania w zależności od odbiorców i sytuacji, o której piszą. Jeśli piszą dokumentację techniczną, styl powinien być formalny, pozbawiony emocji związanych z kreatywnym pisaniem. Jeśli piszą e-mail do jednego z menedżerów wyższego szczebla zaangażowanych w projekt, ich styl byłby bardziej konwersacyjny.

dostęp do informacji

Dostępność to sposób, w jaki informacje w dokumencie mogą być uzyskane przez zamierzoną grupę odbiorców. Dokument techniczny zawiera takie elementy, jak spis treści, nagłówki, stopki i numery stron, aby pomóc czytelnikom w poruszaniu się po dokumencie i znalezieniu potrzebnych informacji. Dokument techniczny przylega również do określonej struktury nagłówków i podtytułów, aby podzielić informacje na odpowiednie sekcje, do których czytelnik może łatwo uzyskać dostęp.

to tylko niektóre z aspektów, które poruszamy jako pisarze techniczni. Jeśli chcesz poprawić swoje umiejętności pisania technicznego, rozważ nasze warsztaty pisania technicznego. Można go dostosować do potrzeb 1 osoby lub 20 osób!

jeśli nie chcesz samodzielnie pisać dokumentu i potrzebujesz pomocy doświadczonego pisarza technicznego, sprawdź naszą Stronę usług.

jesteśmy tu, aby pomóc . Skontaktuj się z nami już dziś!