Category: programming
-
The best technical documentation places relevant information closest to where it will be needed
in programmingIf I had a dime for every time I have followed a long set of instructions incorrectly, encountered an inscrutable error, and had no idea what step I missed or where I went wrong, I’d have gotten another dime today. In the software world, processes are often discovered backwards. We start with the final step,…
-
Command-line tools should have an “explain” flag
in programmingI would love to be able to paste a command into the terminal, add a flag, and have the program explain the options to me and what they mean, like so: This would save me so much time, especially for commands with a lot of options and longer man pages. Every new shell program I…