top | item 46632849

(no title)

loudmax | 1 month ago

AI may never be able to replace the best tech writers, or even pretty good tech writers.

But today's AI might do better than the average tech writer. AI might be able to generate reasonably usable, if mediocre, technical documentation based on a halfheartedly updated wiki and the README files and comments scattered in the developers' code base. A lot of projects don't just have poor technical documentation, they have no technical documentation.

discuss

order

shiroiuma|1 month ago

Exactly. My team's technical documentation is written (in English) by people who don't speak English natively, and it's awful, barely comprehensible many times because these people don't understand articles ("the" and "a") very well and constantly omit them or use the wrong ones. And aside from the poor English, the documentation itself is just bad.

AI would do a great job of fixing their writing, but they don't want to use it, because it's not an official part of "the process".

>and comments scattered in the developers' code base

I'm not so sure about this one. Most devs I've worked with don't use comments.

phendrenad2|1 month ago

"Tech writer" refers to a specific profession, not "programmer when they write docs". But with the second definition, I agree with you