b088086b06
Now, it's all under the notebook umbrella. Seems to be appropriate as it is just my notes after all. I also updated some notes from there. I didn't keep track of what it is this time. Something about more learning notes extracted from my "Learning how to learn" course notes and then some. Lack of time and hurriness just makes it difficult to track but it should be under version control already.
1.6 KiB
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.
Practicing this in your studies is also helpful, creating a primer of the topic that you can refer to. You can then break the examples down and include it in a Spaced repetition session (e.g., include the examples in Anki).
This is not only useful for software documentation, it is also useful for technical writings. This makes it easier to skim (see Speedreading is all about skimming well) and to Prefer referencing over remembering.