mirror of
https://github.com/foo-dogsquared/wiki.git
synced 2025-01-31 01:57:54 +00:00
23 lines
6.7 KiB
HTML
23 lines
6.7 KiB
HTML
<!DOCTYPE html><html><head><meta name="viewport" content="width=device-width"/><meta charSet="utf-8"/><title>Make a style guide for consistency</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>Make a style guide for consistency</h1><section class="post-metadata"><span>Date: <!-- -->2021-05-09 17:30:43 +08:00</span><span>Date modified: <!-- -->2021-05-09 18:26:23 +08:00</span></section><nav class="toc"><ol class="toc-level toc-level-1"></ol></nav><p>Style guides are one of the most common things you'll see when collaborating whether in software, writing, or even in music.
|
|
These dictate what forms are acceptable and how to do such things.
|
|
Having a foundation for what to do and not to do creates less overhead for you and your collaborators.
|
|
<a href="/wiki/2021-04-06-22-25-17">Prefer referencing over remembering</a>.
|
|
</p><p>Even for personal projects, these could come in handy especially if you have to handle it in the future.
|
|
For example, you could keep in mind to <a href="/wiki/2021-02-28-14-52-58">Create examples of ranking complexity when documenting your project</a>.
|
|
</p><p>Writing style guides doesn't have to involve a separate document complete with details and nuances.
|
|
They can be just a section in your README, for example.
|
|
If you do have a complete document, one of the ways to ease introducing it is to create a summarized version of it and link the document for more information.
|
|
</p><p>However, don't fall into obsession for minding every item not following the guidelines.
|
|
Style guides are only meant for consistency first, not clarity.
|
|
Obsessively applied writings could make less sense when read.
|
|
</p><section><h2>Backlinks</h2><ul><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-05-09 17:30:43 +08:00\"","date_modified":"\"2021-05-09 18:26:23 +08:00\"","language":"en","source":""},"title":"Make a style guide for consistency","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":"Style guides are one of the most common things you'll see when collaborating whether in software, writing, or even in music.\nThese dictate what forms are acceptable and how to do such things.\nHaving a foundation for what to do and not to do creates less overhead for you and your collaborators.\n"},{"type":"element","tagName":"a","properties":{"href":"/2021-04-06-22-25-17"},"children":[{"type":"text","value":"Prefer referencing over remembering"}]},{"type":"text","value":".\n"}]},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"Even for personal projects, these could come in handy especially if you have to handle it in the future.\nFor example, you could keep in mind to "},{"type":"element","tagName":"a","properties":{"href":"/2021-02-28-14-52-58"},"children":[{"type":"text","value":"Create examples of ranking complexity when documenting your project"}]},{"type":"text","value":".\n"}]},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"Writing style guides doesn't have to involve a separate document complete with details and nuances.\nThey can be just a section in your README, for example.\nIf you do have a complete document, one of the ways to ease introducing it is to create a summarized version of it and link the document for more information.\n"}]},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"However, don't fall into obsession for minding every item not following the guidelines.\nStyle guides are only meant for consistency first, not clarity.\nObsessively applied writings could make less sense when read.\n"}]}]},"backlinks":[{"path":"/2021-06-18-10-36-37","title":"Writing"}]},"__N_SSG":true},"page":"/[[...slug]]","query":{"slug":["2021-05-09-17-30-43"]},"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> |