wiki/2021-02-28-14-52-58.org

#+title: Create examples of ranking complexity when documenting your project
#+date: "2021-02-28 14:52:58 +08:00"
#+date_modified: "2021-05-02 18:51:00 +08:00"
#+language: en


Some projects such as user applications should include examples of usage varying of the complexity from a simple "Hello world"-esque example to a real-life example that the developer uses.
This gives a quick introduction to the tool as well as subtly giving hints about what you can do with the program.
Examples include the manual pages from [[https://www.freebsd.org/][the FreeBSD project]] where each tool is given a dedicated section for example usage.
Another that stuck out to me is the README of [[https://github.com/naelstrof/maim/tree/b1b28fcb0c3a44e699fd879189316440b7edff22][maim]], a screenshot capture tool, where one of the examples demonstrate that you can pipe binary output which leads to useful things such as [[https://github.com/naelstrof/maim/tree/b1b28fcb0c3a44e699fd879189316440b7edff22][OCR selection]] or a colorpicker.

This is not only useful for software documentation, it is also useful for technical writings.
This makes it easier to skim (see [[file:2021-04-05-12-43-36.org][Speedreading is all about skimming well]]) and to [[file:2021-04-06-22-25-17.org][Learn more with referencing with a bit of remembering]].
Update note-related notes I've also improve how I link my notes a little by seamlessly tying them as I would construct a sentence. 2021-05-03 10:51:55 +00:00			`#+title: Create examples of ranking complexity when documenting your project`
Update wiki as of 2021-04-07 2021-04-07 09:36:32 +00:00			`#+date: "2021-02-28 14:52:58 +08:00"`
Update note-related notes I've also improve how I link my notes a little by seamlessly tying them as I would construct a sentence. 2021-05-03 10:51:55 +00:00			`#+date_modified: "2021-05-02 18:51:00 +08:00"`
Update wiki as of 2021-04-07 2021-04-07 09:36:32 +00:00			`#+language: en`


			`Some projects such as user applications should include examples of usage varying of the complexity from a simple "Hello world"-esque example to a real-life example that the developer uses.`
			`This gives a quick introduction to the tool as well as subtly giving hints about what you can do with the program.`
			`Examples include the manual pages from [[https://www.freebsd.org/][the FreeBSD project]] where each tool is given a dedicated section for example usage.`
			`Another that stuck out to me is the README of [[https://github.com/naelstrof/maim/tree/b1b28fcb0c3a44e699fd879189316440b7edff22][maim]], a screenshot capture tool, where one of the examples demonstrate that you can pipe binary output which leads to useful things such as [[https://github.com/naelstrof/maim/tree/b1b28fcb0c3a44e699fd879189316440b7edff22][OCR selection]] or a colorpicker.`

Update the notes on classic prose 2021-04-22 07:09:54 +00:00			`This is not only useful for software documentation, it is also useful for technical writings.`
Update note-related notes I've also improve how I link my notes a little by seamlessly tying them as I would construct a sentence. 2021-05-03 10:51:55 +00:00			`This makes it easier to skim (see [[file:2021-04-05-12-43-36.org][Speedreading is all about skimming well]]) and to [[file:2021-04-06-22-25-17.org][Learn more with referencing with a bit of remembering]].`