foodogsquared/wiki
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/wiki.git synced 2025-01-30 22:57:59 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
master
wiki/notebook/2021-02-28-14-52-58.org
Gabriel Arazas a71918683d Update learning notes 
As well as tiny bits of extra stuff like Android apps and some
corrections.

Search techniques does make a lot of improvements over graphical
representations (at least for now)!
2021-07-22 14:29:37 +08:00

1.3 KiB
Raw Permalink Blame History

Create examples of ranking complexity when documenting your project

Some projects such as user applications 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 acts as a quick introduction to the project as well as subtly giving hints about what you can do with the program. Examples include…

  • The manual pages from the FreeBSD project where each tool is given a dedicated section for example usage.
  • maim, a screenshot capture tool, has one of the examples demonstrate that you can pipe binary output which leads to useful things such as OCR selection or a colorpicker.

This makes it easier to skim (see Speedreading is all about skimming well) and to Prefer referencing over remembering. Furthermore, Examples and stories are more memorable than explanations.