Pros and Cons of Using #markdown for Technical Writing
▻https://hackernoon.com/pros-and-cons-of-using-markdown-for-technical-writing-34f277418a8a?sourc
Many technical writers either currently use or interested in using Markdown to write their technical documentation. It’s a bit like Marmite — some people love it and other people kind of hate it.Markdown generates some controversy, but it still proves incredibly useful in certain contexts. In this post, we’ll discuss exactly what Markdown is, and whether it’s appropriate for your documentation project.Definition of MarkdownJohn Gruber is the original creator of Markdown, and he defines it as:“Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).”Gruber’s definition shows that Markdown intended for anyone producing content on the web — which nowadays (...)
#editor #technical-documentation #technical-writing #markdown-tech-writing
