News for hackers. Stuff that matters.
Re:The Grand Unified Theory of Documentation by eru on Friday April 16, 2021 @01:09AM (#26829742)
About 8: this habit might make your docs sound a bit monotonous, but it also helps with 'grepping' through them.
Re:The Grand Unified Theory of Documentation by vicda on Friday April 16, 2021 @03:35AM (#26830742)
We don't read documentation to entertained, but to solve problems. How searchable your text is extremely important.
Re:The Grand Unified Theory of Documentation by neetrain on Friday April 16, 2021 @01:18AM (#26829804)
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.
Re:The Grand Unified Theory of Documentation by eru on Friday April 16, 2021 @01:27AM (#26829864)
Yes, literature and technical documents have different requirements.
Re:The Grand Unified Theory of Documentation by bobthepanda on Friday April 16, 2021 @11:58AM (#26835533)
At least in the US my undergrad computer science degree had a course on specifically writing technical documentation