3 ms·
This is committing a fallacy I see far too often at my company: that because something is considered "technically superior" it should be the tool of choice. Thi
by lhorie 7y ago
This is committing a fallacy I see far too often at my company: that because something is considered "technically superior" it should be the tool of choice. This misses the human aspect of a system. Markdown has low barrier of entry, and in a world where more often than not, documentation is poor or non-existent, it doesn't really matter if a documentation system has many bells and whistles if those features get seen as too difficult to learn and result in no docs being written in the first place.
Another important human aspect of documentation is docs are often written by people joining a project late who may already be knees deep trying to understand the projects APIs. Burdening them with learning a documentation system on top of that can definitely a tipping point between "I should document this" to "ah whatever, I'll just slog through the code".
- p1necone 7y agoAsciiDoc specifically is pretty nice though, I prefer it to markdown and it doesn't really have much more of a learning curve.