Comment by simonw

Comment by simonw 5 days ago

11 replies

This is the main reason I'm extremely disciplined about making sure all of my personal projects have automated tests (configure to run in CI) and decent documentation.

It makes it so much easier to pick them up again in the future when enough time has passed that I've forgotten almost everything about them.

sriram_malhar 5 days ago

I'm finding that in this build fast and break things culture, it is hard to revisit a project that is more than 3 years old.

I have a couple of android projects that are four years old. I have the architecture documented, my notes (to self) about some important details that I thought I was liable to forget, a raft of tests. Now I can't even get it to load inside the new version of Android Studio or to build it. There's a ton of indirection between different components spread over properties, xml, kotlin but what makes it worse is that any attempt to upgrade is a delicate dance between different versions and working one's ways around deprecated APIs. It isn't just the mobile ecosystem.

  • wink 4 days ago

    I have relatively good experience with both Rust and Go here. It still works and maybe you need update 2-3 dependencies that released an incompatible version, but it's not all completely falling apart just because you went on a vacation (looking at you npm)

  • alansaber 4 days ago

    Build fast and break things works great if you're the consumer, not the dev polishing the dark side of the monolith (helps if you're getting paid well though)

    • dotancohen 4 days ago

      As a consumer, I can not remember any feature that I was so enamored about having a week earlier than I otherwise would have, at the expense of breaking things.

      • alansaber 4 days ago

        The point is that companies don't actually know what consumers want so a volume / meandering approach is required

appplication 4 days ago

Totally relate. My main project lately is for my wife, and it’s absolutely rock solid from a testing/automation standpoint. The last thing I want to do is accidentally break something and give her a headache when i’m just trying to build her a nice thing that brings her joy.

perrygeo 3 days ago

> (configure to run in CI)

Every time I've believed this, I came back to broken CI.

Depending on your language ecosystem, your CI workflows and build deps stand a greater chance to break than your code.

agumonkey 4 days ago

Do you preemptively force yourself to allocate time for documentation maintenance ?

  • simonw 4 days ago

    Not really.

    I have a rule that any commit which changes the implementation has to include the documentation update at the same time.

    Most of these documentation updates are a sentence or two, or maybe a paragraph. The overhead of incremental documentation updates like that is tiny enough that I don't really think about assigning extra time for them.

    • agumonkey 3 days ago

      Alright, thanks a lot. Gonna help me improve my workflow :)