3 ms·
A bit of time making this more concise and cleaning up the language would go a long way when you get the time. Clarity above all other virtues for documentation
by cincinnatus 14y ago
A bit of time making this more concise and cleaning up the language would go a long way when you get the time. Clarity above all other virtues for documentation, goes doubly for meta-documentation.
- emin_gun_sirer 14y agoVery true. I get wordy when I'm pressed for time. If you write a new, simpler, easier version (Gideon's?), I'll put one in every hotel room.
- cincinnatus 14y agoIt is always as Twain said, "Sorry for the long letter, I didn't have time to write a short one." The essential advice of all writing: the simplest word choice, the fewest words, is doubly true for technical documentation. Unfortunately only 1% of tech writers seem to follow it. And as you say, there never seems to be enough time left to document. This is why: a) the doc should be the spec b) write the doc first. There, that's the concise version of your manifesto :-)