#68 Tech Writer edukuje programistów, czyli co każdy deweloper powinien wiedzieć o pisaniu dokumentacji

Podcast: Tech Writer Koduje · Michał Skowron

Opublikowano: 2024-07-31

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...