• 0 Posts
  • 15 Comments
Joined 1 year ago
cake
Cake day: July 4th, 2023

help-circle



  • Comments get stale and over time transition from: accurate to outdated, to eventually flat-out lies.

    Sounds like some people aren’t doing their work enough then. Code comments are part of the work that a programmer should do, not an afterthought. Who else is gonna update that code if not the programmer? And if a programmer isn’t supposed to update their code and we can just all write clean code that would somehow make us all be better engineers (yeah, I use this title differently from programmers), then why are code comments even a thing?

    Self-documenting code is good and all, but so should there be good comments.




  • Hard disagree that documentation is a waste of time. I think you’re just failing to see and use documentation correctly.

    Tech documentation should never:

    • record implementation details; that’s what commits and PRs are for
    • be about the code, but about the solution, information, or provide guidance; use code comments when talking about code
    • be taken as 100% accurate or infallible, but the general direction or essence should still remain true (related to the 2nd point)
    • be expected to be up-to-date; readers should always look at the created / completed / last edited date and make a judgement how much salt to actually take from it

    Documentation can

    • be some kind of paper trail that shows how we got to where we are
    • provide guidelines for getting started on a project, or some part of a larger project, with more context with respect to the business, so that readers are equipped with sufficient context when diving into the code (READMEs can then just focus on setup and testing instructions)
    • go further into what goes around a solution, eg considered alternatives, what actually requires solving given a functional requirement (it’s not always the case that we can fit a solution within a sufficiently small ticket, so tickets might be too localized to give a bigger picture of how a problem is being solved)
    • record system architecture, with actual illustrations, which can be easier to grok than 50 Terraform files

    Writing these out is also good for people who don’t read code or don’t have the time to read code, eg your tech lead, your manager, Tech VP, etc, people who should have some idea of your system or solution, but not necessarily the implementation detail, so that they can do their work more effectively.

    There’s also a culture where a project, or a sufficiently complex problem, starts with a tech proposal, which would properly capture the problem and do solution planning. It’s easier and faster to change than a PR, and reviewers can read that for context. In any case, this democratizes knowledge, instead of creating more tribal knowledge.


  • It’s not possible for everyone to just tell if it’s supposed to be sarcasm. ADHD makes it hard. A bad day makes it hard. A tiring day makes it hard.

    The downside of the misunderstanding isn’t just downvotes. It’s possibly a proliferation of misinformation and an impression that there are people who DO think that way.

    Being not serious while saying something grim is not a globally understood culture either. It’s more common and acceptable in the Western world as a joke.

    So… call it accessibility, but it’s just more approachable for everyone to just put an “/s”.



  • I’m probably replying to a troll, but I will do so anyways for the sake of those who need to read this.

    If we aren’t in any way bothered to see such narrow-minded reactions to a wrong being righted, then humankind is definitely headed for a few horrible decades ahead, filled with unnecessary strife and conflict out of pure indifference to each other’s backgrounds and current understanding of the world. And I’d even imagine it’d be worse than what we’re already seeing this decade. I suggest you go back and rethink what really matters as humans, instead of focusing on just some narrow definition of what a win is.


  • Wow, wtf is wrong with this comment section? People don’t realize how laws made in the past just stay around until someone steps up to change it? Or y’all don’t have the capacity to look at the world through a different mindset, even if you disagree with the mindset? As much as we all hope that people around the world are accepting, it doesn’t just happen, and you can’t just hope people who don’t understand your PoV will just realize something’s wrong waking up one day.

    Either those, or y’all have either grown too cynical or are trying to be cynical just for the sake of it.

    Can’t y’all just celebrate the fact that this is happening in Japan, an infamous nation that usually tries fervently to preserve their tradition and status quo?



  • When you have a large population with a strongman government, having little appetite for upheavals is likely impossible. Interacting with the Chinese, I’ve learned that their government is always actively monitoring online spaces to silence dissidents amongst their own people, such that their people are used to codify their languages, and switch whenever a code gets added to the list of words that would trigger the attention of authorities. Some years ago, it was something related to meditation (it was used as a code for their gatherings), and so the Buddhists had to change the word they use to avoid unnecessary trouble with the authorities. These don’t get mentioned very often in Western news sources.