writing-prose-like-code

What problem does it solve?

This Skill helps developers write code that is more readable and maintainable by adhering to conventions that make code resemble natural language.

Core Features & Use Cases

• Narrative Method Bodies: Encourages writing methods as if they tell a story, improving readability.
• Boolean Names as English Predicates: Ensures boolean variables and methods are descriptive.
• Domain Vocabulary: Promotes the use of domain-specific language over technical jargon.
• Natural Syntax: Utilizes language features to enhance readability.
• Named Arguments: Improves clarity at call sites by using named arguments.
• Imperative Verb Phrases: Commands and actions are named as imperative verb phrases.
• Fluent Mutation via Method Overloading: Allows method overloading to create a narrative mutation sequence.
• Decision Tables via Pattern Matching: Uses pattern matching to create English decision lists.
• Validation as Complete Sentences: Ensures error messages are clear and informative.
• Composition as Specification: Encourages constructing object graphs as specifications.
• What NOT to Do: Lists common pitfalls to avoid in code.

Quick Start

Apply the writing-prose-like-code skill to your next coding project to improve readability and maintainability.