poznaj.dev

poznaj.dev

Jak pisać lepiej — poradnik dla programistów

Jak pisać lepiej — poradnik dla programistów

Marcin Wosinek's photo
Marcin Wosinek
·May 25, 2022·

4 min read

Niedawno dwóch znajomych programistów zwróciło mi uwagę na istotność umiejętności pisania. Warto skorzystać z ich rad, bo:

  • jeden z nich prowadzi firmę zajmującą się sprzedażą produktów online,
  • drugi w zaledwie kilka lat przeszedł drogę od ukończenia bootcampu do wiodącego programisty.

Poniżej daję wam krótki poradnik na temat tego, jak poprawić teksty tworzone w ramach codziennych obowiązków zawodowych.

Rozbij swoje dzieło na akapity

Pierwszym krokiem na drodze doskonalenia umiejętności pisania jest rozbicie myśli na mniejsze kawałki. Zamiast zrzucać na czytelnika ogromną ścianę tekstu, rób nowe akapity, gdy zmienia się wiodąca myśl. Taki podział tekstu sprawi, że będzie on ekonomiczny, mniej przytłaczający i łatwiejszy w czytaniu. Dzięki mniejszym fragmentom czytelnik nie straci tyle energii na lekturze.

Image description

…i właśnie tak masz nie pisać.

Korzystaj z dostępnych opcji formatowania

Większość systemów, przez które będziesz wysyłać swoje wiadomości, będzie dawać możliwość formatowania tekstu. Najpewniej będą to:

  • pogrubienia,
  • kursywa,
  • nagłówki,
  • podkreślenia,
  • przekreślenia.

Korzystanie z tych elementów szybko sprawi, że Twój tekst będzie bardziej przystępny. Dzięki temu w prosty sposób skierujesz uwagę czytelnika na najważniejsze rzeczy, co zwiększy szansę na osiągnięcie celu Twojego tekstu.

Image description

Diabeł tkwi w szczegółach.

Ułatw lekturę czytelnikowi

Życie swoim czytelnikom możesz ułatwić na dwa sposoby:

  • korzystając z linków HTML,
  • umieszczając w tekście obrazki, aby coś zakomunikować albo wyjaśnić.

Opcje te nie zawsze są dostępne. Kiedy na przykład używam Slacka, niezmiennie irytuje mnie, że nie mogę umieszczać obrazków między akapitami.

Dodatki tego typu znacznie poprawiają czytelność wysyłanego tekstu. Obrazki umieszczone w tekście widać od razu, a tekst nie jest przerywany przydługimi linkami.

Jest to kluczowe przy pracy z ticketami. Wyobraź sobie, że dodajesz do tekstu obrazek w Jira: wszystko będzie klarowne pod warunkiem, że obrazek jest jeden. Jeśli zespół doda kolejnych pięć obrazków w komentarzach, to wszystko stanie się nagle bardzo zagmatwane. Umieszczanie obrazków między fragmentami tekstu sprawia, że wiadomo od razu, który obrazek do czego się odnosi.

Image description

Internet oferuje linki od roku 1991, a obrazki od 1992. Używajmy ich!

Przeczytaj i zredaguj to, co napisałeś

Szczypta redakcji może bardzo poprawić jakość Twojego dzieła. Najlepiej zapisać szkic i wrócić do niego po pewnym czasie – po przerwie albo nawet następnego dnia. Przeczytanie całego tekstu przynajmniej raz przed publikacją powinno pozwolić Ci doszlifować sposób wyrażenia Twoich myśli, co poprawi ogólne wrażenia czytelnika.

Redakcja jest kluczem do dobrego odbioru tekstu. Zajmowanie się tym samemu powinno wystarczyć do większości pisanych przez Ciebie tekstów i jest jedną z podstawowych rzeczy, które jesteś winien swoim czytelnikom.

Image description

Ulepsz swój tekst za pomocą zautomatyzowanych narzędzi

Maszyna potrafi poprawić Twój tekst nie tylko poprzez sprawdzenie go pod kątem poprawności ortograficznej. W dzisiejszych czasach mamy dostęp do zaawansowanych narzędzi, które potrafią robić takie rzeczy jak:

  • wyłapywanie wyrazów napisanych prawidłowo, ale umieszczonych w złych miejscach (w przypadku języka angielskiego zawsze mi się to zdarza z then i than),
  • zaznaczanie strony biernej – pisanie w stronie czynnej „ożywia” tekst,
  • przeredagowywanie zdań tak, aby były łatwiejsze w odbiorze – przynajmniej zdaniem algorytmu.

Jeśli do pisania podchodzisz poważnie, powinieneś zerknąć na aplikacje dostępne na rynku.

Grammarly

Jeśli na YouTubie pojawiają Ci się reklamy podobne do moich, na pewno słyszałeś o tym narzędziu. Korzystam z niego od lipca 2021 roku i jestem zadowolony. To był pierwszy postawiony przeze mnie krok na drodze do poprawienia jakości mojego bloga.

Plusy:

  • rozumie kontekst wyrazów i sugeruje odpowiednie zmiany: podpowie Ci, czy chciałeś napisać it's czy its,
  • zwraca uwagę na nadużywane wyrazy i sugeruje zamienniki,
  • w wersji płatnej może zasugerować przeredagowanie zdania.

Minusy:

  • obsługuje tylko język angielski,
  • wtyczka dla Firefoxa na komputerach Mac ma problemy z Google Docs,
  • płatna wersja kosztuje 144 $ rocznie, co jest kwotą wyższą niż u konkurencji,
  • tu i ówdzie pojawiają się skargi na problemy z bezpieczeństwem i prywatnością. Z tego, co udało mi się sprawdzić, do największego naruszenia bezpieczeństwa doszło w 2018 roku i Grammarly szybko to naprawiło. Problemy związane z prywatnością mają związek z przetwarzaniem zachodzącym na serwerach firmy – korzystając z tego narzędzia, musisz zaufać, że stosuje się do swoich warunków świadczenia usług.

LanguageTool

Plusy:

  • obsługuje większą liczbę języków (korekta gramatyczna 5 języków europejskich), podstawowe funkcje dla 20 języków,
  • masz możliwość własnego hostingu darmowej wersji, dzięki czemu dane będą zawsze pod Twoją kontrolą.

Minusy:

  • kiepski marketing – o asystencie LanguageTool dowiedziałem się dopiero wtedy, kiedy sam zasięgnąłem języka.

Image description

Bądź najlepszym przyjacielem swoich czytelników

Wszystkie podane wyżej wskazówki sprowadzają się do tego, żebyś myślał o osobach, które będą czytać Twój tekst. Twoim zadaniem jest sprawienie, żeby był on łatwy w odbiorze. Wymaga to empatii. Dodatkowy wysiłek powinien Ci się zwrócić: często zdarza się, że czytelnikami Twoich tekstów są: Twój szef albo ludzie, którzy mają wpływ na dalsze losy Twojej ścieżki zawodowej. Nawet jeśli piszesz coś dla kolegów z pracy, Twoje dzieło zostanie najpewniej przeczytane przez wiele par oczu – a reputacja osoby z dobrymi umiejętnościami komunikacji dobrze Ci zrobi.

Co dalej?

Jeśli podoba Ci się ten artykuł, subskrybuj, żeby być na bieżąco, kiedy opublikuję nowy.

 
Share this