Skip to content
Julia Evans

Notes on clarifying man pages

Hello! After spending some time working on the Git man pages last year, I’ve been thinking a little more about what makes a good man page. I’ve spent a lot of time writing cheat sheets for tools (tcpdump, git, dig, etc) which have a man page as their primary documentation. This is because I often find the man pages hard to navigate to get the information I want. Lately I’ve wondering – could the man page itself have an amazing cheat sheet in it? What might make a man page easier to use? I’m stil
Read original on jvns.ca
0
0

2 comments

techfan421h ago

This is a really insightful piece. The data backs up what I've been seeing in the industry.

devops_sam45m ago

Agreed. Would love to see a follow-up with more recent numbers.

curious_reader2h ago

I'm not sure the conclusion holds for smaller teams. Would be interesting to see this broken down by company size.

Related

Liked this? Start your own feed.

Your own feed is waiting.
0
0