3 ms·
* For internal consumption, the code should be THE doc. * For external consumption, the comment of the public interface should be THE doc. Lot of programming l
by _448 5y ago
* For internal consumption, the code should be THE doc.
* For external consumption, the comment of the public interface should be THE doc. Lot of programming languages have tools to write and convert comments to docs.
Writing is improved by reading other's work. Ask these engineers to read fictional and non-fictional books(novels, autobiographies, biographies etc), ask them to read anything written by other engineers excellent at writing: Paul Graham, Linus Torvalds etc. Paul Graham has several articles on writing. Also, both Paul and Linus have mentioned that they re-review their writing before posting. Also ask them to watch good online debates. This all helps in putting ideas to words. Most of the time engineers know what they want to say, but they don't know how to say it.