This is really a neat trick. We should have more such self-documenting scripts indeed.
OK... This is weird and funny. I definitely like the idea of an actor reading this important RFC aloud.
Nice trick! Using vim as man page viewer. I shall try this.
A bit of a self-serving post towards the end. Still I like it because it clearly mention that it's not about dropping all documentation in favor of the code (quite the contrary in fact, documentation is very much needed). It really is about treating code like documentation, putting the same care into it in terms of readability and understandability. If you wonder what code reviews are for... it's also for this readability concern.
Good explanation of why the passive voice should be avoided. Also it gives a few cases where you want to favor the passive voice.
Interesting proposal of structure for technical documentation.
Need to write a tutorial? Here is a good set of rules to follow. Don't be fooled, it sounds simple but it is hard work.
Since the documentation is severely lacking in this area, this ends up being a nice how to. I wish we'd have more like this in the official documentation.
Very good article. I wish I'd see more organisations writing such design documents. They help a lot, and that allows to have a way to track changes in the design. To me it's part of the minimal set of documentation you'd want on any non trivial project.
Nice reminder that even though we try to make things simpler to understand to people, there is a point where we can go too far.
Good advices to improve writing. I should apply such rules to myself more often.
Of course documentation, especially one presenting the architecture, shouldn't be neglected. It takes time and skills of course.
Pick your words wisely. If it does happen every time use "will".
Interesting approach to reduce the amount of undocumented features because we simply forgot to update the documentation. Shows a few inspiring tricks to get there.