RubyFlow The Ruby and Rails community linklog

Documenting Ruby command-line apps (pdf download)

Very few people would be able to use your commandline app without proper documentation. Users would have to read and understand the source code to know what options and commands the app provides, what the options mean, and what arguments the app accepts or requires. If you intend to make the app available to others and use the app multiple times periodically, for a long time, you must document your app. Luckily, there’s a standard for building cli apps that include the right features and proper, well-formatted documention.

Comments

Post a comment

You can use basic HTML markup (e.g. <a>) or Markdown.

As you are not logged in, you will be
directed via GitHub to signup or sign in