Technical Writing for Developers
Just be cause to instruct computers to do your bidding all day doesn't mean you should not spend some time learning how to communicate iwth humans well.
This is an opinion peice. It's a collection of my opinions.
This is a collection of notes about how to write well for those of us in Information Technology.
This doucment is therapy for all the shitty stuff out there that will never be fixed.
- Documentation - Who, Where, and When
Should I document in code or in a wiki page or in a read me?
Yes.
Different places and forms of documenation are appropriate and effective for different projects.
- Acronyms
You should use them , but not too hard, and you should follow some guide lines.
The art of writing is quite old and is employed by various fields. Each field has it's own uances.
Some places you might look for gu8delines are:
- Legal Writing
- Acedemic Writing
- Scientific Writing
