Jak piszesz blogi techniczne? [Zamknięte]

Zwykle dużo czytam o programowaniu. Kiedy temat, który czytam, nie jest bezpośrednio związany z moją pracą (np. Czytanie o niektórych algorytmach, których nie używam w codziennej pracy), zapominam o nich.

Jednym ze sposobów wzmocnienia tego, czego się nauczyłem, jest pisanie blogów. Jestem początkującym w pisaniu blogów. Kiedy zacząłem pisać, zorientowałem się, że to bardzo trudne. Nawet zwykłe odtworzenie treści zajmuje około dwóch godzin. Napisanie przemyślanego bloga często zajmuje cały dzień, a czasem weekend.

Czy to normalne? Wszelkie wskazówki dotyczące pisania samouczków technicznych / blogów technicznych?

Pisanie jest trudne, dobre pisanie jest jeszcze trudniejsze. Problemem w wyjaśnieniu czegoś jest to, że wymaga ono więcej wiedzy niż tylko „wiem”. Uważam, że blogując: 1. znajduję pokrewne tematy, które muszę zrozumieć, 2. identyfikuję, gdzie moje rozumienie jest płytkie

Przeczytaj te slajdy http://www.ai.uga.edu/mc/WriteThinkLearn.pdf . Dużo wyjaśniają na temat pisania (a nawet porównują to do programowania)

Każda jakość pracy wymaga czasu i wysiłku. Należy się tego spodziewać.

Ukończenie niektórych moich starszych wpisów na blogu zajęło około 3 tygodni. Piszecie szkic, ponownie go czytacie, dokonacie niezbędnych poprawek, skanujecie go ponownie, a następnie sprawdzacie. To wymaga czasu.

Jeden prosty pomysł, jak utrzymać motywację. Jeśli planujesz coś dużego, zastanów się, czy warto podzielić pracę na 2-3 części i opublikować je osobno. Części muszą oczywiście być przydatne dla czytelników we własnym zakresie. Następnie, ponieważ zajmują mniej czasu, bardziej prawdopodobne jest, że przejdziesz i doprowadzisz częściową pracę do końca.

Kilka wskazówek od tego nieznanego technicznego blogera:

• Weryfikuj (nie tylko czytaj) kod, który wprowadziłeś, wycinając i wklejając podgląd z wiersza poleceń lub pliku tekstowego do uruchomienia. Kilka rzeczy (np. Zakończenia linii, wcięcia i znaki Unicode) może zostać pomieszanych podczas przesyłania z edytora (lub powłoki) na stronę internetową iz powrotem.
• Poproś człowieka, aby sprawdził pisownię, gramatykę i zawartość - pokazuje, że włożono wysiłek w poprawienie i poprawienie czytelności artykułów. Jeśli nikogo nie ma w pobliżu, przeczytaj go ponownie przed opublikowaniem.
• Jeśli platforma blogów ma podświetlanie składni , użyj go. Jeśli nie, opublikuj kod w innym miejscu i umieść tam link.
  • Wniosek: trzymaj duże fragmenty kodu z dala od tekstu artykułu. Jest to nieco niejasne, ale jeśli tekst wyjaśnia, jak działa niektóre kody, dobrze jest dołączyć fragment kodu. Jeśli przedstawia program do pobrania, lepiej skorzystać z interfejsu sieciowego VCS.
• Każdy artykuł powinien być czytelny sam . Odwoływanie się do innych artykułów jest w porządku, ale nie zakładaj tylko, że czytelnik przeczytał wcześniej inne posty.
• Używaj innych formatów niż tekst, gdy pomagają one w zrozumieniu. Dla niektórych rzeczy kod jest wystarczający, ale dla niektórych obraz lub nawet animacja mogą być znacznie bardziej zrozumiałe.

Często uważam, że trudny post na blogu trwa tak długo, ponieważ wymaga badań; badania te nie tylko pomagają w tworzeniu postów na blogu, ale także pomagają w budowaniu własnej wiedzy. Jak powiedziałeś, wzmacniasz wiedzę, pisząc post; poszerzasz także swoją wiedzę. Wykorzystaj potrzebny czas i doceń to jako doświadczenie edukacyjne.

Tak, pisanie blogów technicznych zajmuje trochę czasu. Dla mnie pisanie zajmuje najkrótszy czas (nawet godzinę lub nawet dzień, w zależności od długości). Następnie edycja i przepisywanie zwykle trwa dłużej (do dwóch, a nawet trzech dni). Innym wspomnianym aspektem, który wymaga czasu, jest wyjaśnienie dowolnego przykładowego kodu. Lubię też spędzać czas na znajdowaniu linków pomocniczych dla moich tematów. To wszystko wymaga czasu!

Sądzę, że mógłbyś teraz pisać blogi techniczne. Sugeruję, abyś to zrobił, kiedy staniesz się ekspertem w jakiejś konkretnej dziedzinie. Weekend nie wydaje się zbyt długi. wszystko zależy od złożoności tematu. Myślę, że mówię, że rdzeń twojego pomysłu powinien przyjść do ciebie w naturalny sposób Wykonanie może (i potrwa) dłużej.

Ludzie szukają na blogu porad ekspertów… nie eksperymentów noobowych. ale mówię w ogólnym sensie .. Nie chcę cię zniechęcać do pisania blogów. Pamiętaj jednak o następujących rzeczach.

1. Twój blog powinien powiedzieć coś nowego. Nie tylko gromadzić dane i umieścić go na swoim własnym blogu

2. Bądź absolutnie pewien tego, co mówisz, tj. Trzymaj się silnych wyników empirycznych lub wysoce przetestowanych koncepcji lub rzeczy, których doświadczyłeś z pierwszej ręki .

3. Przygotuj się na krytykę.

4. Naucz się technik pisania blogów (dokładność, zwięzłość itp.)

5. Napisz coś, bo uważasz , że powinno być napisane; nie dlatego, że myślisz, że zostanie przeczytany.

Elementy stylu

Myślę, że pisanie techniczne jest zgodne z tymi samymi zasadami, co każde pisanie. Jeśli czytasz tylko jedną książkę o pisaniu, powinna to być klasyczna Strunks „The Elements of Style” . Przechodzi przez listę rzeczy, które poprawią twój skład, przede wszystkim (IMO), „Pomiń niepotrzebne słowa”.

Poleciłbym także „ O pisaniu ” Stephena Kinga . Choć bardziej dotyczy pisania fikcyjnego, wciąż zawiera wiele klejnotów dla każdego początkującego pisarza, szczególnie w takich obszarach, jak edycja i proces pisania.

Biorąc to pod uwagę, trudną rzeczą w pisaniu technicznym nie jest pisanie rzeczywiste, ale wyjaśnienie swoich myśli na temat tego, o czym piszesz. Błędne myślenie prowadzi do złego pisania. Dobre pisanie wymaga jasnego zrozumienia swojego tematu, dlatego nauczanie i pisanie jest tak doskonałym sposobem na opanowanie przedmiotu.

Cóż, pisanie postów na blogu zajmuje mi bardzo dużo czasu. Często piszę je przez kilka dni, a nawet zostawiam je w formie szkicu na kilka tygodni, od czasu do czasu czytając je ponownie i poprawiając i poprawiając tu i tam.

To wymaga czasu, ale jeśli to jest cena za napisanie czegoś, czego nie wstydzę się później, myślę, że warto.