Let’s take a closer look at the qualities that characterize a good software development standard, so we can understand it in more detail.
Relevance
- Clearly mention who the standard is intended for.
- Describe the situations or conditions under which the standard should be used.
- Specify the exact circumstances or conditions under which a rule or standard applies.
Clarity
The content is obviously and straightforward.
- Do not use many jargon or complex terms.
- Define all terms and abbreviations at their first occurrence.
- Explain why a certain guideline or rule is in place.
Direction
The content provides a call to action that audiences understand what to do next.
- Start with the most crucial information so that audiences can quickly grasp the key points.
- Clearly state which topic a rule, guideline, or standard applies to.
- Provide references to additional resources to deepen understanding.
Boundaries
- The content defines what is in-scope and out-of-scope.
- Clearly distinguish between mandatory requirements (MUST), recommendations (SHOULD), permissions (MAY), and prohibitions (MUST NOT).
- Provide examples of DO and DON’T.
Validity
- Shows explicitly the validity status [DRAFT, FINAL, DEPRECATED] of its content.
Timeliness
- Reflect the latest good practices and technologies.
- Indicate the version number and the date of the latest modification or update.
Trustworthiness
- Clearly specify the process for addressing conflicts or differences within the guideline or with other guidelines.
