Comment

Comment by hartleybrody

This is probably the skill you remembered: https://github.com/AminBlg/SimpleEnglish

I have been using it for a few weeks, and it significantly improves the quality of the docstrings and code comments, as well as the readability of spec docs.

I have also added a few key bullet points to my AGENTS.md and have found the results to be very effective and generating plans and code that looks like something I would have written:

-----------

    ## planning, design and spec docs

    - the highest design goal is simplicity -- in our systems and our mental model -- even if if means edge cases are unaddressed and could potentially fail
    - please practice "ya ain't gunna need it" (YAGNI) do not add unnecessary guardrails
    - do not plan to add caching, many layers of unnecessary abstraction or other premature optimizations
    - look for places where adding or clarifying an invariant would simplify the code or the overall system

    please specifically try to avoid:

    - redundant calculations or duplicated work
    - duplicated conditionals or state-machine logic
    - storing state that can be derived from other state, which could drift and become out of sync over time
    - leaky abstractions across layers of the application
    - multi-line comments explaining a variable name or a single statement. well chosen names and design should makes these unnecessary, as the code is self-documenting
parent hartleybrody 2 months ago

No comments yet

Be the first to share your thoughts.

Live from the official Hacker News API

A modern reader for Hacker News · SvelteKit + Skeleton