When Guidelines Should Be Descriptive or Prescriptive
Post from September 13, 2008 (↻ December 12, 2016), filed under Web Development.
This and many other posts are also available as a pretty, well-behaved e-book: On Web Development. And if you’re only interested in a robust overview on coding guidelines, check out my little book on it: The Little Book of HTML/CSS Coding Guidelines.
Every time I’m putting up guidelines and standards one of the decisions I need to make is whether or not the guidelines, or which parts of them, should be descriptive or prescriptive. For coding guidelines this could mean the difference between, say, “the markup should be valid” and “the markup must be valid” (think RFC 2119).
So when to recommend or describe something to be followed, and when to force and prescribe? This decision depends on three factors:
The goal. Is there a need to sensitize and establish a particular mindset and process first, and is there some time as well, or is it desirable to quickly enforce certain rules, even when the results are already solid? Establishing a mindset suggests to go for recommendations first, enforcing something to come up with clear requirements.
The situation. Is everybody doing well, or is the situation rather bad? If it’s going well, then an approach based on strict rules might be best in order to create support for everything that’s already been achieved, and the guidelines might only mean written testament of formerly unwritten laws. If the situation’s bad, then recommendations, descriptive guidelines will work best to push into the right direction.
The priority. Low priority issues don’t need to be treated with strict rules right from the bat; they can allow for some flexibility. Only critical issues may get all the attention. Coding guidelines that require lowercase letters for hex color values but leave it open to use valid CSS exhibit an “interesting” sense for what’s important.
Let’s take the “valid markup” example from the introduction to make decisions for a few imaginary companies’ coding guidelines:
Company 1, the goal: Have valid output be the prerequisite to develop and improve the company’s websites. Changing the guideline? “The markup must be valid.”
Company 2, the situation: suboptimal. Nobody validates, valid code only appears accidentally. How to handle a guideline about valid markup? Take the gentle approach: “The markup should be valid.”
Company 3, the priority: Low, observing that the company uses elements according to their semantics, and that only few accessibility issues have been spotted. Changing the guideline? Depends on the value of the goal, philosophy, and quality entitlement; if it was me, I’d go for “the markup must be valid.”
As we can see, the “descriptive vs. prescriptive” problem is not just known among linguists talking grammar. It’s of relevance for our industry, too. I may have missed opportunities to make better points but I hope that one thing came through, namely that “descriptive vs. prescriptive” is something we need to keep in mind.
This is likely to be the last post I publish during my stay in the U.S.—I’ve been taking a few days off—but the next one shouldn’t be out for more than one and a half weeks. Consider taking a very short survey if you didn’t already (thanks to all who have already casted their vote!), or enjoy some all-time classics 😊
About the Author
Jens Oliver Meiert is a tech lead and author (sum.cumo, W3C, O’Reilly). He loves to try things, particularly in the realms of philosophy, art, and adventure. Here on meiert.com he shares and generalizes and exaggerates some of his thoughts and experiences.
If you have any thoughts or questions (or recommendations) about what he writes, leave a comment or a message.
On September 15, 2008, 8:59 CEST, lup4lz said:
Comparing development guidelines with the descriptive/prescriptive grammar debate is dangerous.
Prescriptive grammar is always been a losing battle: languages change regardless of grammar rules while descriptive grammar is the science of observing the way people use language.
Any guidelines concerning a web development are instead there for specific reasons. They may help control the costs of current or future development of the site, the interoperability of software and portability of data as well the possible changes in the environment where the website or application needs to operate.
It’s easy to enforce loose guidelines in a small team but in a more complex project they should be formalized together with the reason why they exist. This way a developer can make an informed decision on when the guidelines should or should not be followed. This way you could take a guideline as a rule that can be bent as long as you know why you are doing it and are aware of the implications of the decision.