nw-fp-usable-design

Solid

Naming conventions, API ergonomics, and usability patterns for functional code

Web & Frontend 526 stars 55 forks Updated 1 weeks ago MIT

Install

View on GitHub

Quality Score: 95/100

Stars 20%
91
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# FP Usable Design Make functional code usable. The developer is the user of your design. Apply usability thinking to code organization, naming, and architecture. Cross-references: [fp-domain-modeling](../nw-fp-domain-modeling/SKILL.md) | [fp-hexagonal-architecture](../nw-fp-hexagonal-architecture/SKILL.md) | [fp-algebra-driven-design](../nw-fp-algebra-driven-design/SKILL.md) --- ## 1. Core Insight [STARTER] The user of software design is the developer, not the end user. When developers struggle, blame the design, not the people. Pressure, team churn, unclear specs, and noisy environments produce unusable designs. Improve the design. --- ## 2. Five Evaluation Goals [STARTER] | Goal | What It Means | How to Assess | |---|---|---| | **Learnability** | How quickly a new developer becomes productive | Timed tasks for unfamiliar developers | | **Efficiency** | How fast common tasks are performed | Count unnecessary navigation and decisions | | **Memorability** | How easily proficiency returns after time away | What do returning developers re-learn? | | **Error resistance** | How many bugs the design induces | Track bug locations; ask "what design change prevents this category?" | | **Satisfaction** | How pleasant to work in the codebase | Developer interviews, retrospectives | --- ## 3. Naming Conventions [STARTER] ### Domain Language in Function Names Use domain expert's vocabulary, not mathematical conventions or technical jargon. No `OrderFactory`, `OrderManager`...

Details

Author
nWave-ai
Repository
nWave-ai/nWave
Created
3 months ago
Last Updated
1 weeks ago
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category