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 https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/).

Informacje dodatkowe:

• Konferencja Web Summer Camp: https://websummercamp.com
• "Democratizing Design for Better Collaboration", Stephanie Stimac: https://www.youtube.com/watch?v=ZATMLWKIObA&list=PLsL1X_98-_XDD1Lm32Sk8HPyPgZ0e1JeX&index=3
• "Guard Clause", DevIQ: https://deviq.com/design-patterns/guard-clause
• Colima: https://github.com/abiosoft/colima
• "#67 Tech Writer żegna "foo", "bar" i "baz", czyli jak tworzyć dobre próbki kodu", Tech Writer koduje: https://techwriterkoduje.pl/blog/2024/6/26/67
• "Structured writing", Wikipedia: https://en.wikipedia.org/wiki/Structured_writing
• "Golden rules for writing docs", Tech Writer koduje: https://techwriterkoduje.pl/golden-rules
• "How did over 300 skeptics start writing docs?", Rafał Pawlicki (soap! 2018): https://www.youtube.com/watch?v=FpcSJa5rEpE
• "Style guide, czyli księga stylu: jak trzymać fason w UX writingu", UX Writing Wiwisekcja: https://open.spotify.com/episode/4jGjLxt8igNqOCmgb8tOmi?si=33167b19519549bb
• "Top 10 tips for Microsoft style and voice", Microsoft Writing Style Guide: https://learn.microsoft.com/en-us/style-guide/top-10-tips-style-voice
• "Software Engineering at Google", Titus Winters, Tom Manshreck, Hyrum Wright: https://www.oreilly.com/library/view/software-engineering-at/9781492082781/