Write code like a human will maintain it

(unstack.io)

133 points | by ScottWRobinson 2 hours ago ago

82 comments

  • cadamsdotcom an hour ago

    Write yourself a /review command. That is an empty markdown file at `.claude/commands/review.md`. In it, put a checklist of things the agent should look for. When you’re ready to have your agent review the code, type `/review`. The checklist will be examined and it’ll plan out some findings to ask you if you want them fixed.

    Mine starts with “Enter plan mode. Examine the differences on this branch vs. main. Consider: ...” and proceeds to a bullet list of things.

    Any time I notice something in code review and have to get the agent to fix it.. I throw it on the list!

    My list is like 200 items now. Know what? Agents don’t care that they just got a wall of generic feedback, they happily look into all the bullet points.

    I added “ensure the new things aren’t duplicating code that already exists elsewhere” and it gave me such a surprise - it really truly started planning cleanups!

    We are just scratching the surface. We have to give tools to our tools so they can use them to be better tools for us.

    • dugmartin a minute ago

      I have my own review skill (I think it predates when Claude added theirs) and one thing I'd add to your description is tell it to examine all the code and then, based on the changes, do a multi-role review of the code again using N of the following roles: ... (where ... is a long list I have like Senior Engineer, Security Engineer, WCAG specialist, etc). Claude will spawn those reviews in parallel and then consolidate the feedback. I do spec based development so I just have my skill append the issues to the spec so I have a trail of issues and decisions.

    • throwaw12 43 minutes ago

      Can you share your list?

      I am curious what does it contain, for me a lot of times its a back and forth with agent until it "looks good to my eyes and taste", but haven't written any such list yet, because it is context dependant, in some projects I forgive minor issues, or allow magical numbers, but in other projects I force agent to use constants with meaningful names `SECONDS_IN_A_DAY = 24 * 60 * 60`

    • wismwasm 9 minutes ago
    • ebiester an hour ago

      You should do an experiment of splitting that up to multiple reviews that are logically together. My hypothesis is that you may be losing signal due to the amount of text expected back.

      • Espressosaurus a minute ago

        Yeah. I have a set of 5 review prompts attacking different problems, an adversarial review, and then a final synthesis, with the best results gotten by multiple passes using multiple models. Expensive but it actually finds real problems that the single pass reviews rarely seem to find.

      • conception 43 minutes ago

        Or a dynamic workflow. $$$ but lots of coverage.

    • is_true an hour ago

      Nice. I had a file with code samples (old code I wrote), including formatting and I asked to use it as a reference.

      Will try your approach to distill the code to bullet points.

  • planb 38 minutes ago

    I have good results with this prompt after every larger change: Now do a final code check. Is everything tidy and do the components adhere to the principle of separations-of-concerns. Is everything in an understandable and maintainable state? Do we make any assumptions that may not be true anymore? Is any code left over from previous edits or experiments that does not belong into the codebase? Is the documentation still representing the current state of code?

    • Benjammer 5 minutes ago

      I usually just say “make sure this code is professional and ready to deliver as a senior engineer” and it usually infers all that stuff you said plus more things as well. I try to give it the goal and let it decide what to do.

      One thing I usually keep having to point out directly is to remove all “progress tracking” code comments and make sure all comments are appropriate for long term maintenance in the code base. Claude tends to leave comments like “button click causes save now, no longer uses onBlur” when the code really never used onBlur, that was just a thing Claude wanted to do earlier in the same task/branch and I redirected it at some point.

    • Ancalagon a minute ago

      Just pull the slot machine lever

    • cyanydeez 15 minutes ago

      good, but this is just a verbose "make no mistakes"; it'd probably make more sense to just setup a nightly cron job that loops through the prior days' work and writes some morning tasks of the same character.

      The models will interpret this willynilly; but nonetheless, it's often a better than doing nothing.

    • chopete3 25 minutes ago

      This is a good example of AI native thinking. Teach AI everything and ask it if it has learnt throughly learnt. The results are surprisingly good.

      I am following similar steps from this article https://www.lucasfcosta.com/blog/backpressure-is-all-you-nee...

  • egonschiele 6 minutes ago

    In a similar vein, here's my favorite prompt: "Please review the tests you've written. Will the tests actually test what they're meant to? If the code breaks, will the test fail?" It's amazing how often LLMs will write tests that don't test anything.

  • luciana1u 4 minutes ago

    Write code like a human will maintain it — and that human is you at 3am six months from now, fueled by regret and cold coffee.

  • internet101010 2 minutes ago

    No. I will generate code in a way that makes it easier for clankers to maintain it, because they will actually be doing the maintaining. In practice, this means that most of my time is dedicated to improving the repo harness because the state of the repo harness directly determines the quality of the codebase as a whole.

    At a minimum, there should be precommit checks and CI workflows that cause PRs to fail if the documentation is not up-to-date and synced with the other docs.

  • hollowturtle 6 minutes ago

    We still need to discuss this things for real? Aren't they already taken for granted after all this "experimenting" with LLMs? I'm wondering when we will discuss hand coding again without treating it like a taboo anymore. LLMs can be useful in so many ways it's tiring knowing people are delegating the entire source code typing to agents, to me it's like hearing from people that the web is good and we should be happy with it

  • alexpotato 2 hours ago

    There is an old quote:

    "Add comments to your code under the assumption that the next person to maintain it is a homicidal maniac who knows where you live"

    • SoftTalker 4 minutes ago

      Used to work with a guy who would frequently say "a comment is an apology" i.e. the comment is there because the code itself is not clear. That can be the case, but I generally find more comments better than fewer, especially if they relate the code to actual business or functional requirements and don't just restate what the code is doing.

      Years ago I would often write comments first. I.e. start with describing the overall goals. Then break it down into routines and order of operations, all still in plain english. Once I was happy with that, I'd break up the comments with blocks of code. I guess this is sort of like "literate programming" though I was doing it long before I ever heard that term and I still have never read much about it. It's almost more like I was prompting myself towards the end goal. The downside of this approach is that the comments do end up more or less just explaining in english what the code is doing, so maybe aren't quite as useful to future maintainers.

    • TimTheTinker 30 minutes ago

      Right now the comments that upset me the most are LLM TMI-style comments that break encapsulation by talking about the behavior of specific current callers of a function right above the function definition.

      I recently reacted angrily in a PR review comment after encountering one for the umpteenth time... that caught me off guard. I didn't know I was capable of that.

      • fphilipe 3 minutes ago

        This is what has been frustrating me most lately. Even though I have a rule in my global CLAUDE.md that says:

        > Only write comments to explain the why when it is not obvious from the code (rationale, gotchas, constraints). Do not comment on the what — well-named code already says it. Do not comment on how a framework works.

        It still keeps adding these bad comments. When I then ask it to review the comments based on my preferences it then deletes most of them or improves them.

        Today I asked Claude why it disrespects my preference and it said that the surrounding code was like that and it followed that style. It suggested I add this line to my global CLAUDE.md file:

        > The comment rule above beats the style of the surrounding code: neighboring files with what-style comments are not license to write more of them, and comments carried along when porting or copying code must be re-judged against the rule, not kept for consistency.

        Let's see if that improves things.

      • jawilson2 10 minutes ago

        Yeah, agreed. These have started popping up a lot more recently, where I get a 5 sentence paragraph explaining how function overloading works in c++.

    • hansonkd an hour ago

      The comments that drive the most homicidal behavior are outdated or inaccurate comments rather than no comments.

      • saghm an hour ago

        Sure, but the proportion of code that drives homicidal behavior is heavily weighted towards non-comments. You're a lot more likely to piss off whoever inherits your code with the code that actually does something being bad or a lack of documentation than with comments.

        • jraph an hour ago

          I'm quite fine with no comments but correctly named variables and functions. This can't become out of sync contrarily to "out of band" comments. I take this over commented code with poorly named stuff any day.

          I've also seen a lot of comments that restate what the code already says and that's just noise, more work to keep in sync, an additional thing that can fail, and more cognitive load because you have to read twice the same thing (best case, if code and comment are still in sync). That's the result you risk when you think you must comment your code.

          I appreciate the occasional comment that explains why something seems overly tricky or weird or not immediately intuitive. Once, I had left such a comment that saved myself years later from making a mistake. Of course, this should be kept at a minimal level. It leads to me liking clear code with few comments the most. (Some guidelines, even if it's not perfect, to limit complexity and spaghetti code help a lot).

          Function, class, module documentation is also useful so you don't have to read the whole thing and you know what it's intended to provide (which is slightly different than simply what it provides, and this differences is important).

          • AnimalMuppet 38 minutes ago

            I worked with this guy. He'd write the code, and comment where needed, and then he would ask "How can I make this comment unnecessary?" The answer was usually to rename something, so that what he was doing was obvious.

            • jraph 35 minutes ago

              Nice, I love this. That's pretty satisfying.

        • mekoka 18 minutes ago

          Ignorance will always be a better starting point for discovery than wrong assumptions. If you leave comments, they must reflect what the code is actually doing. If during edit it's no longer the case, at least mark them as stale. The next best thing is indeed to remove them.

      • minraws an hour ago

        Both can be true at the same time, we can be equal opportunity murderers who treat lazy verbosity and hippester terse code.

      • gowld an hour ago

        Put your home address in the comments. Problem solved.

        • sejje 30 minutes ago

          I moved after I wrote the comment. It's hard to keep everything up to date.

  • godshatter 10 minutes ago

    Could someone show me what a shared helper would look like in this case? This code looks easily readable to me and I fear abstracting it will just make it harder to reason about. Is it just variable_with_a_better_name = that conditional?

  • schnebbau an hour ago

    That sounds like a good idea, but shipping 10x as many features and bugfixes sounds better.

    I started using AI with the best intentions. Checking everything before committing. Improving output by hand if it didn't quite follow the existing code style guidelines or variables were not named as well as they should be. Or if it did something sloppy or hacky.

    Now, AI GOES BURRRRRRRRRRRR! If the tests pass it's good to ship. AI can deal with the problems it may create. No problems so far.

    • thevillagechief 25 minutes ago

      Are you my colleague? It's fine if it's your own personal app, but please don't do this in a large complex codebase in a team. It's entirely depressing. You can use AI and still write good code. I think it's actually probably easier to write maintainable code with AI.

    • saghm an hour ago

      How did you know you're not stuck at a local optimum where the AI could iterate even faster if you enforced higher quality on what it produced?

      To make up some hypothetical numbers in order to illustrate with math: if you ship bugfixes 10x faster but then have 11x more bugs you need to fix, that's not a net improvement. Even if it's only 5x more bugs, maybe you could reduce that to 2x if you changed how you worked to only be 8x as fast in a way that produced higher quality code. Similarly, maybe you could cut the time it needed to produce a new feature by 50% if your code were higher quality by moving 20% slower.

      My point in all of this isn't that you literally need to work the same way you did before you had these tools, but that framing it as either "move fast and ignore the code" and "use the same exact heuristics you would in the pre-LLM days for what code is acceptable" is a false dichotomy. If you aren't thinking about how effectively you're using these tools and whether there are changes you could make to move even faster because "AI go brrr", I think you've lost the plot in the same way you probably think that other people in this thread have.

      • geraldwhen a minute ago

        It’s a new form of development. The thing that the author didn’t state is that to work the code base at all, you must also use these tools and workflows.

        Manual edits literally aren’t possible. You can’t grok the code growth and the new patterns fast enough to be productive.

        This does work. I’ve seen it in real products. Nobody has a real mental model of the code flows. But with enough money in Claude credits it doesn’t matter.

        The spend to support this development model is something like $50/day/developer.

    • hansonkd an hour ago

      Yeah, the flip side of the article is that Fable level models can fix the majority of codebases created from the past 3 years and one shot it to a fixable state that is "human maintainable"

    • swatcoder an hour ago

      > shipping 10x as many features and bugfixes sounds better

      I understand you're excited about the tool, but for the sake of earnest discussion here, maybe commenters like yourself can tone the hype down to plausibility?

      Claims like this are just nonsense. It's not how product development works.

      How do you even have so many bugs left to fix if the tool is so fast and productive? Surely, you didn't have a backlog of tens of thousands of bugs that you're still chewing through? And of course, the volume of new bugs much be minimal since the AI-composed additions introduce "no problems so far". If it works like you say, which we'll accept in good faith per HN guidelines, you must have exhausted your backlog long ago.

      And if you've indeed exhausted your bug backlog long ago (incredible!), you're left to talking about shipping "10x as many features". Yet no product has a limitless capacity for features. Nobody would want to use software so bloated and churning that was gaining features at such a pace. And who is designing and specifying them so quickly anyway? If it works like you say, which we again accept in good faith, you must have stalled out on your feature list long ago.

      If the AI indeed allows you to "[ship] 10x as many features and bugfixes", and we take what you say in good faith, then one of the following seems to be implied:

      * you've fixed all your bugs and blew through your mature feature designs already, leaving your AI agents sitting idle for all but a few hours a week, while you're bottlenecked on feature design and your software product is bloated beyond imagination

      * your coding productivity before AI was absolutely glacial by industry standards such that "10x" productivity for you is actually much closer to "0.5-2x" for others

      Any insight into which of those it might be?

    • embedding-shape an hour ago

      > That sounds like a good idea, but shipping 10x as many features and bugfixes sounds better.

      This work great until you reach a certain size, then good (or even "not bad") code is required otherwise the model spins its wheel trying to ensure the change is correct.

      The way I've measured how good/bad the code is (for AI) is to have one "baseline fixed change" that I measure how long time it takes to implement. Always in the beginning (less than 10K LOC, as just some measurement), this baseline change will take 2-3 minutes. As you add more code, the same change starts to take 5-6 minutes, and once you hit 1 million LOC, it can take as long as 10 minutes, even though the change is the same.

      It's when this baseline task starts to take longer time, that you need to update the design/architecture/layout/whatever, to better fit the task/domain, and to actually make it easy to maintain and still possible to add changes without spending 10 minutes. So its at this point you refactor, and once done, the baseline task will again be easy for the model to do.

      So yeah, if all you do is smaller projects, then "shipping 10x as many features" is easy and doable, for the lifetime of the projects. But once the projects start to accumulate technical debt, the model will have a harder time making sure the changes are correct, and suddenly "shipping 2x as many features" is maybe doable, but you could still have had 10x if you just spend slightly more time on the actual design and architecture of the program.

      • schnebbau an hour ago

        Yes, this resonates. I have noticed things slow down over time. But fortunately my app will never grow that big so I don't think it will be an issue.

        The solution, as you say, is probably to break it down into isolated sub-components that are only aware of each other's APIs and nothing more.

        • javier123454321 36 minutes ago

          Yeah for personal software, enterprise practices wouldn't make sense.

    • matt_kantor an hour ago

      How long has "so far" been?

      • pauletienney an hour ago

        I second that question

      • schnebbau an hour ago

        Since November.

        • AnimalMuppet 17 minutes ago

          Yeah... in at least some circumstances, "maintainable" means, like, 20 years. 8 months is not an adequate test.

    • geraneum an hour ago

      That sounds like a good idea but how do you know what you’re shipping?

    • exabrial an hour ago

      One does not exclude the other

    • latexr an hour ago

      Man, I bet Jia Tan is simultaneously kicking themselves and having a field day. All those years of wasted effort gaining trust and making good contributions to try to land a sophisticated backdoor into a tool via layers of indirection, and then not long after we have devs just going “I don’t need to read this code, or prioritise, or think about what makes sense, just prompt for fractals of kitchen sinks and ship it”.

      Anthropic themselves have admitted you don’t need much to poison LLMs¹. I can’t wait for us to discover the backdoors that are being introduced. I hope it happens soon so people get to their senses. Bah, what am I saying, when (not if) that happens, the response will just be to throw more LLMs at it.

      ¹ https://www.anthropic.com/research/small-samples-poison

    • carimura an hour ago

      I find myself doing this but then I worry that the slop will just compound and 3, 6, 12 months from now as my services scale I'll have a harder time operating them. Maybe I'm wrong.

      • cmrdporcupine an hour ago

        The bigger problem is the number of things you don't understand will grow substantially from under your feet, and then you'll slip on it.

  • uhhhd 8 minutes ago

    Counterpoint: This no longer matters because we are not going back to hand-writing these functions. These patterns were designed to make code easier for humans to read and write, but that is no longer the primary way software is built.

    • hollowturtle 4 minutes ago

      Counterpoint: as long as context don't rot or it's less effective that starts maintaining repetitions only slightly different. Also

      > we are not going back to hand-writing these functions

      do you really think there isn't a good chunk, if not the majority outside some bubbles, of developers that still hand code? Crazy to hear, I bet you're not a programmer

  • carimura an hour ago

    I continually run codebases through different models to have them look for bad code smells like repeated code. That's been pretty effective. You do have to maintain over time or else you end up with a sloppy mess which I can only imagine compounds.

    • sejje 29 minutes ago

      Do you think it matters that it's a different model?

      Or is it more about the review process and a context reset?

  • ramshorst 5 minutes ago

    So the new prompt is "Write code like a human will maintain it" ?

  • Snoopfrogg 26 minutes ago

    Or we start writing code without LLMs.

    • danielbln 11 minutes ago

      No one is stopping you. It's only if you want someone to pay you for hand writing code that you might feel a certain competitive pressure that makes it economically difficult, let's say.

    • el_io 12 minutes ago

      Cat is out of the bag. Other than recreational programming I doubt many will write code without any form of LLM.

  • exabrial an hour ago

    What I'm seeing is the organizations that had written code standards:

    * define the software layers, their function, and the max depth allowed

    * establish a corp code formatter for each language, along with a process to PR it

    * establish a business vocabulary and what the terms mean

    * establish a data dictionary, make it part of the database schema/table/col comments

    Are far more successful with LLMs. You _should_ have been doing this years ago, but with LLMs its a super power.

  • phaser an hour ago

    The first line of my AGENTS.md is: You are an engineer who writes code for *human brains, not machines*.

    Taken from: https://github.com/zakirullin/cognitive-load/blob/main/READM...

  • dsagent an hour ago

    Very much this. LLMs are not producing code humans can maintain unless you take your time with them and still care about the quality of the output.

    Maybe someone has the perfect claude.md that solves this problem but I have not seen it.

    • imhoguy an hour ago

      CLAUDE.md (or AGENTS.md) is not good place to put all code change rules, because these rules would dillute the context and "distract" the agent e.g. during bugs triage or business analysis.

      Instead modularize the knowledge with skills and specialized MD files. Agent should lazy load what is needed to do focused work.

      Skills have usage description metadata, but with free files you can simply instruct agent with CLAUDE.md to load them, e.g.: "Before you attempt to change any frontend code first load and follow `docs/{JS|HTML|CSS}_coding_rules.md`".

  • wxw an hour ago

    The key idea here is that your codebase is context that will be used for future changes. And context determines the model’s output, so it’s still worth having a well-designed codebase.

    Easier said than done to be honest, especially if there are many people (and their agents) pushing code. It’s hard to keep up these days.

  • ge96 35 minutes ago

    Been getting these vibe coded PRs ugh code PR submitter can't even explain

  • k4200 26 minutes ago

    I'm not sure this guy is using the same LLMs as we do. A small AGENTS.md or CLAUDE.md easily prevents issues like that.

  • francisofascii an hour ago

    Before LLMs we didn't have time for code quality. LLMs make our jobs faster, so now we have time to dedicate to code quality, right?

  • cebert 2 hours ago

    It's interesting that the author didn't mention considering updating their agentic code review prompt to keep an eye out for repetitive/duplicate code.

  • DCKing an hour ago

    I run various forms of workflows to run dedicated QA, code review (of various flavors) simplification and text simplification agents. Especially the simplification goes a long way to remove dumb padding, duplication and efficiency. Dedicated docs/comment simplification is also becoming more and more necessary on recent models. For things like feature development in my workflow, the majority of time the agents run and tokens spent is critiquing the code from various perspectives and it's not close.

    Of course, this doesn't solve the overall issue that agents don't write code like you and still requires a lot of human attention in planning and code review out to clean up leftover issues, and e.g. challenge bad assumptions about architecture and real-world context. A human is still very much needed to cull the slop (or, more gratuitously: align the agent). But IME it does help avoid a lot of pitfalls and makes the code high quality a lot more quickly.

  • bdcravens an hour ago

    Humans have been writing unmaintainable code well before LLMs came along.

  • trjordan an hour ago

    AI is so miserable for this. It's so focused on doing what you ask, it forgets that there's stuff worth doing that you didn't ask for, like defining reasonable abstractions.

    Getting away from stuff like this is exactly why I want to use AI. When I say "implement this for idle but active users," I _want_it to define isUserActiveIdle() and stuff these 4 conditionals in it. Having to check the generated code for stuff like this undoes, like .... all the benefit of using AI.

    AI makes all these little decisions for us. I can about some of these decisions. I just want to notice when it's doing this without having to make my eyes bleed reading 10k lines of generated code a day.

  • andrewjneumann an hour ago

    Have a bit of a contrarian view on this tl;dr don’t write code for human consumption if you use AI; BUT you have to accept AI coding lock in and change how you work.

    Funny enough, discussed this yesterday

    Stop Optimizing Code for Humans https://youtube.com/live/eLn4-XA-KdQ?feature=share

  • esafak 43 minutes ago

    Just run weekly cron job to assess code quality and highlight candidates for refactoring. In addition to doing the same in each PR, of course, but things can get through.

  • jasonlotito 25 minutes ago

    linting tools, static analysis, CPD, etc. These are all old things you can continue to use and are much more robust than anything you can prompt. These should be standard when using LLMs. In fact, you can tighten the rules even more enforcing more restrictions so you ONLY get the output you want. put this behind a pre-commit hook and a CI job that runs on a PR, and it will work wonders.

    You can have all the prompts you want on top of this, but if you don't have this automated stuff running behind the scenes, you aren't serious about these issues.

    Looking through some of these comments here, I see lots of people rewriting concrete rules in markdown willing to spend tokens on the hope AI won't miss it where an actual program won't.

  • deadbabe an hour ago

    I absolutely will not write corporate code like humans are maintaining it anymore, because I don’t have any confidence actual humans will be maintaining it.

    For personal projects, I can trust that I myself will be maintaining things so I still write things like it matters, but I do not extend the trust to others.

  • jdw64 an hour ago

    Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live. Code for readability.

    — John F. Woods (1991)

  • cyanydeez 2 hours ago

    AI isnt taking my job. my company is supporting local AI for development. who ever comes after me will have the same hardware and models or better. unless a MBA is put in charge, my boss and predecessors can maintain and build out as needed.

    bottom up AI use seems a godsend compared to the corporate AI rat race.

    i setup some slop reporting systems and ensured my boss knows theyre great starting points but serious use requires real time investment.

  • ing33k an hour ago

    And hope it works?

    I’m pretty sure many people who use AI to write emails or blog posts add "make it sound like a human wrote it" to their prompts. We all know what the result usually looks like.

    If AI is writing my code, I'd rather have it focus purely on correctness and efficiency than on making the code easy to read.

    heck! I might even ask it to imitate Arthur Whitney’s style.

    /s

  • tristan666 2 hours ago

    u right