Thought I'll give this a try. Over the years I've been collecting notes, checklists, best practices, rules, ... that are more or less related to working as a software developer. I've recently started to write them down in a more formal way, and thought why not share some of them in this "new" quickie posts format.
To start this off, we'll go a bit meta and define some rules for writing these best practices, ... down. I'll be leaning on the RFC 2119 to convey how much leeway for example rules allow.
- In general, the main key words according to RFC 2119 should be used, e.g. must, must not instead of shall, shall not.
- Key words must follow English spelling conventions regarding capitalization.
- Key words must be emphasized using bold formatting.
Top comments (0)