mirror of
https://github.com/foo-dogsquared/wiki.git
synced 2025-01-31 01:57:54 +00:00
18 lines
7.8 KiB
HTML
18 lines
7.8 KiB
HTML
<!DOCTYPE html><html><head><meta name="viewport" content="width=device-width"/><meta charSet="utf-8"/><title>Create examples of ranking complexity when documenting your project</title><script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script><script id="MathJax-script" async="" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script><script type="text/x-mathjax-config">
|
|
MathJax = {
|
|
tex: {
|
|
inlineMath: [ ['$','$'], ['\(','\)'] ],
|
|
displayMath: [ ['$$','$$'], ['[',']'] ]
|
|
},
|
|
options = {
|
|
processHtmlClass = "math"
|
|
}
|
|
}
|
|
</script><meta name="next-head-count" content="6"/><link rel="preload" href="/wiki/_next/static/css/52fc2ba29703df73922c.css" as="style"/><link rel="stylesheet" href="/wiki/_next/static/css/52fc2ba29703df73922c.css" data-n-g=""/><noscript data-n-css=""></noscript><link rel="preload" href="/wiki/_next/static/chunks/main-ae4733327bd95c4ac325.js" as="script"/><link rel="preload" href="/wiki/_next/static/chunks/webpack-50bee04d1dc61f8adf5b.js" as="script"/><link rel="preload" href="/wiki/_next/static/chunks/framework.9d524150d48315f49e80.js" as="script"/><link rel="preload" href="/wiki/_next/static/chunks/commons.0e1c3f9aa780c2dfe9f0.js" as="script"/><link rel="preload" href="/wiki/_next/static/chunks/pages/_app-8e3d0c58a60ec788aa69.js" as="script"/><link rel="preload" href="/wiki/_next/static/chunks/940643274e605e7596ecea1f2ff8d83317a3fb76.4841a16762f602a59f00.js" as="script"/><link rel="preload" href="/wiki/_next/static/chunks/pages/%5B%5B...slug%5D%5D-1aa198f87ede1cd0e1dc.js" as="script"/></head><body><div id="__next"><main><h1>Create examples of ranking complexity when documenting your project</h1><section class="post-metadata"><span>Date: <!-- -->2021-02-28 14:52:58 +08:00</span><span>Date modified: <!-- -->2021-07-22 13:59:53 +08:00</span></section><nav class="toc"><ol class="toc-level toc-level-1"></ol></nav><p>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...
|
|
</p><ul><li><p>The manual pages from <a href="https://www.freebsd.org/">the FreeBSD project</a> where each tool is given a dedicated section for example usage.
|
|
</p></li><li><p><a href="https://github.com/naelstrof/maim/tree/b1b28fcb0c3a44e699fd879189316440b7edff22">maim</a>, a screenshot capture tool, has one of the examples demonstrate that you can pipe binary output which leads to useful things such as <a href="https://github.com/naelstrof/maim/tree/b1b28fcb0c3a44e699fd879189316440b7edff22">OCR selection</a> or a colorpicker.
|
|
</p></li></ul><p>This makes it easier to skim (see <a href="/wiki/2021-04-05-12-43-36">Speedreading is all about skimming well</a>) and to <a href="/wiki/2021-04-06-22-25-17">Prefer referencing over remembering</a>.
|
|
Furthermore, <a href="/wiki/2021-07-21-17-59-19">Examples and stories are more memorable than explanations</a>.
|
|
</p><section><h2>Backlinks</h2><ul><li><a href="/wiki/2020-06-27-18-31-40">Write down the simplest possible example</a></li><li><a href="/wiki/2021-04-07-15-09-24">Classic prose</a></li><li><a href="/wiki/2021-05-09-17-30-43">Make a style guide for consistency</a></li><li><a href="/wiki/2021-06-18-10-36-37">Writing</a></li></ul></section></main></div><script id="__NEXT_DATA__" type="application/json">{"props":{"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},"page":"/[[...slug]]","query":{"slug":["2021-02-28-14-52-58"]},"buildId":"Ie9t5zutrXP6Of75Cb5xF","assetPrefix":"/wiki","nextExport":false,"isFallback":false,"gsp":true}</script><script nomodule="" src="/wiki/_next/static/chunks/polyfills-99d808df29361cf7ffb1.js"></script><script src="/wiki/_next/static/chunks/main-ae4733327bd95c4ac325.js" async=""></script><script src="/wiki/_next/static/chunks/webpack-50bee04d1dc61f8adf5b.js" async=""></script><script src="/wiki/_next/static/chunks/framework.9d524150d48315f49e80.js" async=""></script><script src="/wiki/_next/static/chunks/commons.0e1c3f9aa780c2dfe9f0.js" async=""></script><script src="/wiki/_next/static/chunks/pages/_app-8e3d0c58a60ec788aa69.js" async=""></script><script src="/wiki/_next/static/chunks/940643274e605e7596ecea1f2ff8d83317a3fb76.4841a16762f602a59f00.js" async=""></script><script src="/wiki/_next/static/chunks/pages/%5B%5B...slug%5D%5D-1aa198f87ede1cd0e1dc.js" async=""></script><script src="/wiki/_next/static/Ie9t5zutrXP6Of75Cb5xF/_buildManifest.js" async=""></script><script src="/wiki/_next/static/Ie9t5zutrXP6Of75Cb5xF/_ssgManifest.js" async=""></script></body></html> |