#68 Tech Writer edukuje programistów, czyli co każdy deweloper powinien wiedzieć o pisaniu dokumentacji
Pisanie dokumentacji jest trudne, co do tego nie mamy wątpliwości. Programiści nie raz w swojej karierze napotykają sytuację, w której muszą opisać jakąś procedurę lub stworzyć README. O ile aktualizacja istniejącej dokumentacji jest do przejścia, to napisanie czegoś od zera może wydawać się zadaniem nie do wykonania.
Czy na pewno? Okazuje się, że deweloperzy mogą wiedzieć więcej o pisaniu dokumentacji niż im się wydaje. Wystarczy tylko zmienić sposób myślenia na temat tego procesu i poznać kilka podstawowych zasad tech writingu.
W naszej rozmowie łączymy filozoficzne rozważania o podobieństwach pomiędzy kodowaniem i pisaniem dokumentacji z praktycznymi wskazówkami dla programistów na temat pisania dokumentacji.
Dźwięki wykorzystane w audycji pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 (creativecommons.org/license...).
Informacje dodatkowe:
- Konferencja Web Summer Camp: websummercamp.com
- "Democratizing Design for Better Collaboration", Stephanie Stimac: www.youtube.com/watch?v=ZAT...
- "Guard Clause", DevIQ: deviq.com/design-patterns/g...
- Colima: github.com/abiosoft/colima
- "#67 Tech Writer żegna "foo", "bar" i "baz", czyli jak tworzyć dobre próbki kodu", Tech Writer koduje: techwriterkoduje.pl/blog/20...
- "Structured writing", Wikipedia: en.wikipedia.org/wiki/Struc...
- "Golden rules for writing docs", Tech Writer koduje: techwriterkoduje.pl/golden-...
- "How did over 300 skeptics start writing docs?", Rafał Pawlicki (soap! 2018): www.youtube.com/watch?v=Fpc...
- "Style guide, czyli księga stylu: jak trzymać fason w UX writingu", UX Writing Wiwisekcja: open.spotify.com/episode/4j...
- "Top 10 tips for Microsoft style and voice", Microsoft Writing Style Guide: learn.microsoft.com/en-us/s...
- "Software Engineering at Google", Titus Winters, Tom Manshreck, Hyrum Wright: www.oreilly.com/library/vie...
