undefined | Better HN

0 pointseru5y ago0 comments

About 8: this habit might make your docs sound a bit monotonous, but it also helps with 'grepping' through them.

0 comments

4 comments · 2 top-level

neetrain5y ago· 2 in thread

I don't know whether it is only in my country, but teachers in school teach students otherwise. Not repeating the same word for the same things is alright for elegant literature, but problematic in the digital era.

eruOP5y ago

Yes, literature and technical documents have different requirements.

bobthepanda5y ago

At least in the US my undergrad computer science degree had a course on specifically writing technical documentation

vicda5y ago

We don't read documentation to entertained, but to solve problems. How searchable your text is extremely important.

j / k navigate · click thread line to collapse