Hacker News
new
|
past
|
comments
|
ask
|
show
|
jobs
|
submit
login
eru
on April 16, 2021
|
parent
|
context
|
favorite
| on:
The Grand Unified Theory of Documentation
About 8: this habit might make your docs sound a bit monotonous, but it also helps with 'grepping' through them.
vicda
on April 16, 2021
|
next
[–]
We don't read documentation to entertained, but to solve problems. How searchable your text is extremely important.
neetrain
on April 16, 2021
|
prev
[–]
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.
eru
on April 16, 2021
|
parent
|
next
[–]
Yes, literature and technical documents have different requirements.
bobthepanda
on April 16, 2021
|
parent
|
prev
[–]
At least in the US my undergrad computer science degree had a course on specifically writing technical documentation
Consider applying for YC's Summer 2026 batch! Applications are open till May 4
Guidelines
|
FAQ
|
Lists
|
API
|
Security
|
Legal
|
Apply to YC
|
Contact
Search: