Y
Hacker News
new
|
ask
|
show
|
jobs
by
eru
1897 days ago
About 8: this habit might make your docs sound a bit monotonous, but it also helps with 'grepping' through them.
2 comments
vicda
1897 days ago
We don't read documentation to entertained, but to solve problems. How searchable your text is extremely important.
link
neetrain
1897 days ago
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.
link
eru
1897 days ago
Yes, literature and technical documents have different requirements.
link
bobthepanda
1896 days ago
At least in the US my undergrad computer science degree had a course on specifically writing technical documentation
link