{"pageProps":{"metadata":{"date":"\"2021-02-28 14:52:58 +08:00\"","date_modified":"\"2021-07-22 13:59:53 +08:00\"","language":"en","source":""},"title":"Create examples of ranking complexity when documenting your project","hast":{"type":"root","children":[{"type":"element","tagName":"nav","properties":{"className":"toc"},"children":[{"type":"element","tagName":"ol","properties":{"className":"toc-level toc-level-1"},"children":[]}]},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"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.\nThis acts as a quick introduction to the project as well as subtly giving hints about what you can do with the program.\nExamples include...\n"}]},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"The manual pages from "},{"type":"element","tagName":"a","properties":{"href":"https://www.freebsd.org/"},"children":[{"type":"text","value":"the FreeBSD project"}]},{"type":"text","value":" where each tool is given a dedicated section for example usage.\n"}]}]},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"element","tagName":"a","properties":{"href":"https://github.com/naelstrof/maim/tree/b1b28fcb0c3a44e699fd879189316440b7edff22"},"children":[{"type":"text","value":"maim"}]},{"type":"text","value":", a screenshot capture tool, has one of the examples demonstrate that you can pipe binary output which leads to useful things such as "},{"type":"element","tagName":"a","properties":{"href":"https://github.com/naelstrof/maim/tree/b1b28fcb0c3a44e699fd879189316440b7edff22"},"children":[{"type":"text","value":"OCR selection"}]},{"type":"text","value":" or a colorpicker.\n"}]}]}]},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"This makes it easier to skim (see "},{"type":"element","tagName":"a","properties":{"href":"/2021-04-05-12-43-36"},"children":[{"type":"text","value":"Speedreading is all about skimming well"}]},{"type":"text","value":") and to "},{"type":"element","tagName":"a","properties":{"href":"/2021-04-06-22-25-17"},"children":[{"type":"text","value":"Prefer referencing over remembering"}]},{"type":"text","value":".\nFurthermore, "},{"type":"element","tagName":"a","properties":{"href":"/2021-07-21-17-59-19"},"children":[{"type":"text","value":"Examples and stories are more memorable than explanations"}]},{"type":"text","value":".\n"}]}]},"backlinks":[{"path":"/2020-06-27-18-31-40","title":"Write down the simplest possible example"},{"path":"/2021-04-07-15-09-24","title":"Classic prose"},{"path":"/2021-05-09-17-30-43","title":"Make a style guide for consistency"},{"path":"/2021-06-18-10-36-37","title":"Writing"}]},"__N_SSG":true}