News for hackers. Stuff that matters.

A comment on The Perks of a High-Documentation, Low-Meeting Work Culture. Parent comment

Re:The Perks of a High-Documentation, Low-Meeting Work Culture by namdnay on Tuesday November 22, 2022 @02:47PM (#33710391)
My experience is that for internal documentation the time spent explaining things to a technical writer is bigger than the time spent writing the documentation

This isn’t the case for external documentation, that has to be more polished, needs sign offs and images and demos and stuff - tech writers can come in useful here

[ Parent | on HN ]
Re:The Perks of a High-Documentation, Low-Meeting Work Culture by pmoriarty on Tuesday November 22, 2022 @04:31PM (#33711791)
Most developers just don't like writing docs, are too busy to write them, and aren't very good writers anyway.

So even on those rare occasions when they do actually document something, the documentation tends to be pretty bare-bones and not very readable.

Good technical writers are worth their weight in gold.

[ Parent | on HN ]
Re:The Perks of a High-Documentation, Low-Meeting Work Culture by bazmattaz on Tuesday November 22, 2022 @05:10PM (#33712261)
Having worked with software engineers for the last 10years I can confirm, most don’t like documentation. At least 80% dont
[ Parent | on HN ]
Re:The Perks of a High-Documentation, Low-Meeting Work Culture by still_grokking on Tuesday November 22, 2022 @07:11PM (#33713348)
Which is a funny statement as almost all devs like to have documentation.
[ Parent | on HN ]
Re:The Perks of a High-Documentation, Low-Meeting Work Culture by nmfisher on Tuesday November 22, 2022 @09:52PM (#33714570)
If I'm simply consuming a library, I find most real-world documentation to be pretty superfluous. A full working example is usually enough to understand how things fit together.

If I'm working on a library, design docs and commented code is nice though.

[ Parent | on HN ]
Re:The Perks of a High-Documentation, Low-Meeting Work Culture by dividefuel on Tuesday November 22, 2022 @08:22PM (#33713884)
It may take more time to explain it to a tech writer than it would for you to write it, but in most cases the final docs written by a tech writer will be much better.
[ Parent | on HN ]
Re:The Perks of a High-Documentation, Low-Meeting Work Culture by euroderf on Saturday November 26, 2022 @06:42AM (#33751875)
The tech writer's output will be a Force Multiplier.
[ Parent | on HN ]