Don’t forget to add incompetent leadership to that list. If feature needs to be shipped by some arbitrary deadline and the engineers are forced to rush through the design process, you end up with a patchwork hack of tech debt that leads to more tech debt.
- 0 Posts
- 2 Comments
Joined 2 years ago
Cake day: July 31st, 2023
You are not logged in. If you use a Fediverse account that is able to follow users, you can follow this user.


By hand—if you have experience writing roff typesetting—it is.
Having a program do it for you… you’re going to get something, but it won’t be correct and you will need to fix most of it.
A few problems come to mind:
It’s a macro-based typesetting language. As a consequence, there’s a one-to-many association between representations in Markdown with some equivalent in
roff. A Markdown paragraph is just a paragraph, but inroffit could be an un-indented paragraph, a paragraph with first-line indentation, a paragraph with line-wrap indentation, or a paragraph with a left margin.Rendering a man page, you have multiple different implementations of
manand multiple different implementations of *roff(roff,troff,groff,nroff). The set of macros and features that are available differ depending on which implementation, resulting in one-size-fits-all solutions targeting the lowest common denominator.Ironically, the one-to-many association goes both ways. With Markdown, you have code fences, quotes, italic text, bold text, and tables. With lowest-common-denominator manpage
roff, you have paragraphs and emphasis that will either be shown as bold or inverted. If you’re lucky, you might also be able to use underlines. If Markdown tables are no wider than 80 characters, you could preprocess those into plain characters, at least.Despite being more structured with its typesetting, the contents of a manpage are mostly still unstructured. The individual sections within the page and its use of indentation and emphasis are entirely convention, and not represented in the source code by anything more than just typesetting macro primitives.
It could work out if you generate both the Markdown and
manpage from something with more explicit structure. If the plan is to go from a loose Markdown document into a manpage, you’re going to end up having to write your Markdown document almost exactly like a manpage.