Muszę pisać dokumenty techniczne, takie jak podręczniki, raporty i artykuły w czasopismach.
Ostatnio zaczynam zdania od „To ” dużo czasu. Na przykład
Umieść jedną boję znakującą w lokalizacji GPS kotwicy, a drugą w lokalizacji GPS ramy. To znacznie ułatwia nawigację.
lub
Pliki dziennika będą przeanalizowane pod kątem ustawień kalibracji i innych metadanych. Ten proces może potrwać kilka minut w przypadku bardzo dużych plików.
lub
Jeśli zostały włożone nowe baterie, magnetometr należy ponownie skalibrować. Ta operacja jest podobna do ponownej kalibracji często wymaganej podczas korzystania z kompasu w smartfonie.
Czy te zdania są w porządku, czy są jakieś inne konstrukcje zdań, które lepiej czytać? Czy powinienem to zaakceptować i przejść dalej?
Komentarze
- Dokumenty techniczne powinny być pisane dla przejrzystości, a nie elegancji czy wyższego stylu. Myślę, że podane przez Ciebie przykłady są jasne i wymagają mniej przetwarzania poznawczego niż rozwiązania alternatywne. Mówię, trzymaj się ich i ruszaj dalej.
- To znacznie ułatwia nawigację. To byłoby bla. To sprawia, że nawigacja jest bla. Zaprawdę, zaprawdę, powiadam wam, że znacznie ułatwiłoby to nawigację.
Odpowiedź
Jest wyraźna korzyść z kontynuowania tego, co robiłeś do tej pory.
To jest to, że powtórzenie wzorca
Poinstruuj czytelnika, aby natychmiast wykonał czynność
a następnie
Opis / komentarz dotyczący wyniku działania i / lub korzyści,
zmniejsza obciążenie poznawcze czytelników: nie są oni stale zobowiązani do wykonywania dodatkowej pracy polegającej na interpretowaniu różnych formatów prezentacji i struktur zdań w celu sortowania instrukcji od opisów lub zrozumienia ich wzajemnych relacji.
Sposób, w jaki obecnie prezentujesz informacje do przeczytania ers pozwala im od razu wiedzieć, czego się od nich oczekuje i dlaczego.
Fakt, że zdanie zaczynające się od „To” jest w rzeczywistości użytecznym sygnałem dla twoich czytelników, że to, co zaraz nastąpi, jest prawdopodobnie opisem lub komentarzem dotyczącym czynności, o wykonanie której właśnie poprosiłeś.
Ten aspekt prezentacji materiału jest jednym z ważnych sposobów, w jaki dokumentacja techniczna różni się od literatury.
W zależności od stylu autora, część przyjemności czytania fikcji zależy zaskoczenia nieoczekiwanymi zestawieniami i małymi łamigłówkami, z których niektóre są tworzone lub uczynione bardziej intrygującymi przez zmianę sposobu prezentacji materiału czytelnikowi.
W Twoim przypadku celujesz (lub powinieneś) dla odwrotnego rezultatu: przewidywalność twojej prezentacji i przejrzystość zrozumienia twoich czytelników będą iść w parze. Względna zwięzłość zdań i powtarzalność formatu w twojej dokumentacji ograniczają możliwości tworzenia niezamierzonej niejednoznaczności.
Warto ponieść w min d jeden ważny powód, aby uniknąć dwuznaczności w dokumentacji technicznej: jest to nie tylko irytujące, ale może nawet być niebezpieczne lub szkodliwe, jeśli czytelnik jest zdezorientowany wykonaniem niewłaściwej czynności (takiej jak zasilenie obwodu, który nie powinien być zasilany).
Komentarze
- @geometrikal – To ' to prawdopodobnie zazdrość o moje spiczaste uszy i uroczy mały nosek.
- Doskonała odpowiedź @Erik Kowal. Dlatego zagłosowałem za tym 🙂
Odpowiedź
Prawie każde słowo lub fraza może być nadużywane, ale nazwanie tematu (agenta, „postaci” lub tematu) w jednym zdaniu, a następnie odniesienie się do niego za pomocą this w następnym zdaniu to doskonały sposób, aby pomóc czytelnikom przejść przez fragment w sposób jasny i łatwy. Jest to przykład głównego typu ciągu tematycznego , istotnego elementu stylistycznego większości dobrego pisania.
Jest możliwe, że czasami udałoby się znaleźć lepszy sposób wyrażenia, zwykle przez wydłużenie poprzedniego zdania o jedną lub więcej klauzul, ale – zwłaszcza gdy „zajmujesz się złożonym materiałem – mniej długich zdań może pomóc Twoim czytelnikom w procesie. (Nie ma nic złego w dobrze skonstruowanych, długich zdaniach, ale wolę pary zdań w twoich przykładach od wszelkich możliwych sposobów ich łączenia.)
W fikcji z dużą ilością dialogów jesteśmy często znajdujemy wiele wystąpień słowa powiedział. Nie jest automatycznie lepiej przejść przez to i spróbować zastąpić wiele z nich alternatywnymi czasownikami ( płakał, mamrotał, emitował itp.). Niektóre słowa są często powtarzane bez zwracania uwagi na powtórzenie. Dzieje się tak (!), Ponieważ dobrze i cicho wykonują swoje zamierzone funkcje.
Odpowiedź
Wszystkie zdania wydają mi się w porządku. Ale jeśli chcesz pozbyć się „tego” na początku drugiego zdania, możesz nieco przepisać pierwsze zdanie.
Na przykład zamiast
Umieść jedną boję znakującą w lokalizacji GPS kotwicy, a drugą w lokalizacji GPS rama. To znacznie ułatwia nawigację.
pisz
Umieszczanie jednej boi znakującej w lokalizacja GPS kotwicy, a druga lokalizacja GPS ramki, znacznie ułatwia nawigację.
Zamiast
Pliki dziennika zostaną przeanalizowane pod kątem ustawień kalibracji i innych metadanych. Ten proces może zająć kilka minut w przypadku bardzo dużych plików.
zapis
Przetwarzanie plików dziennika pod kątem ustawień kalibracji i innych metadanych może zająć kilka minut w przypadku bardzo dużych plików.
Moim zdaniem trzeci przykład jest prawdopodobnie najlepszy pozostawiony tak, jak go zacytowałeś.
Komentarze
- Jak przypuszczam zdajesz sobie sprawę, twoje alternatywy zmieniają znaczenie pierwotnych par zdań. Twoja pierwsza zmiana traci główną funkcję oryginału: polecenie wdrożenia. Twoja druga zmiana traci główną funkcję oryginału: informowanie, że nastąpi analiza.
- W przypadku pierwszej możesz użyć głosu pasywnego: Nawigacja jest łatwiejsza dzięki temu procesowi. Nie jest to jednak najwspanialsze zdanie. Po drugie, co powiesz na ” Bardzo duże pliki mogą sprawić, że ten proces zajmie kilka minut „?