News for hackers. Stuff that matters.

A comment on Ask HN: What is key to good technical documentation?.

Re:Ask HN: What is key to good technical documentation? by jbverschoor on Sunday September 08, 2019 @08:38AM (#20910183)
Proper architecture

Remove the unneeded layers

Use of standardized frameworks

Proper datamodels

Proper naming

Proper error handling or no handling at all

A few diagrams

What to tell the manager.. maybe that he should’ve been more involved in the overall quality of the product and motivation of his team

[ Parent | on HN ]
Re:Ask HN: What is key to good technical documentation? by jnxx on Sunday September 08, 2019 @08:50AM (#20910252)
That sounds more than can be done in a month. I don't think this wish would make the fairy happy.
[ Parent | on HN ]
Re:Ask HN: What is key to good technical documentation? by ka0lin on Sunday September 08, 2019 @08:47AM (#20910233)
Proper, like good?
[ Parent | on HN ]