Usability Metrics for better Notation
(1)
As a developer,
I want to be able to predict and assess, to some extent, how my decisions affect usability and maintainability
So that I don't need to rely solely on intuition and user testing, can proceed faster, and communicate potential issues with my colleagues.
(2)
As a member and contibutor of ecobytes,
I desire a based and consistent wording within ecobytes publications and conversations
So that I can easily understand and communicate issues around the core topics and activities of the association,
And don't need to spand unnecessary cognitive effort for translating material into a shape I understand.
—
The "Cognitive dimensions of notations" [wikipedia] provide actionable categories by which to judge and improve any notation we are writing, including:
- Diagrams
- Articles
- Machine-executed, human-readable Code
- Human-executed protocols and guides
- Workflow conventions and categories
- Workspace and directory structures
- Naming conventions
- DSLs and data ontologies
- ...
Refer to the above link for the exhaustive list, including items in the 'Other Dimensions' section. I have noticed that we have been applying many of them in our conversations, and it's so nice to see them laid out in an apparently quite exhaustive list. Let's integrate that list in our implementation strategy whenever notation is involved! Naming things is, as far as my experience goes, the hardest part of computer programming, so let's embrace this tool to make it easier.