Live data from Hacker News

Why does writing matter in remote work?

timcasasola.com

31–40 of 86 posts

Re: Why does writing matter in remote work?

#31
In my new job I do a lot of writing; documentation, architecture (ADR's), and lots of details in the user stories themselves - although those are mainly for myself.

But I have a fear. What if nobody bothers to read it? What if they start reading it but just glaze over because of the sheer volume of it? I mean the ADR's for example are a lot of 'internal' musings that I've considered.

I am a solo developer on this project at the moment (my colleagues do other stuff), so I've got nobody to check my work either.

At my last job, my colleague just said to not bother (we were err, very different personalities in that regard), it's wasted effort, I'm not going to bother reading it, just show me how to start it then show me the code. Which I guess works in smaller codebases in easier domains, but this won't be one of those.

Is there a similar article that emphasizes that people should read other people's writings?

Re: Why does writing matter in remote work?

#32

Whenever you compose an email, put your ask in the first sentence. Do you want information from them? Do you want them to do something for you? Put it in the first sentence. Then put the explanation and details in the rest of the email.

Also, at least if you're writing it to me, don't write several rambling pages where you also disparage other people in the project and then ask me at the very end of the email to not share it with the group. Put that don't share request at the top in caps, bold. Sorry, still sore years later.

Oof. Yeah, complaints about other people - if they are NOT formal - should not be in writing in the first place.

If you're making a formal complaint, by all means. But otherwise, treat it like you're posting it on the internet for everyone to see.

Re: Why does writing matter in remote work?

#33

Whenever you compose an email, put your ask in the first sentence. Do you want information from them? Do you want them to do something for you? Put it in the first sentence. Then put the explanation and details in the rest of the email.

One of the depressing things I notice as I get older is that no-one reads anything. If it's not in the first sentence (or, for some people, last sentence) it is ignored. So I write 1 line emails. It's on HN too ofcourse; people respond to the first sentence without reading the rest, missing every and all nuance. Great stuff.

Yup, that's the downside of modern day internet culture; even as a software developer, my main and most used skills are reading and writing. And with reading, since there's so much of it people end up skim reading / skipping.

Once upon a time I was on an internet forum and I would read each and every post. Nowadays, if it's longer than a paragraph long and not by someone I care about, I just glaze over - I can't be bothered anymore. Mind you, having less time for that kinda thing also doesn't help.

Re: Why does writing matter in remote work?

#34

In my new job I do a lot of writing; documentation, architecture (ADR's), and lots of details in the user stories themselves - although those are mainly for myself. But I have a fear. What if nobody bothers to read it? What if they start reading it but just glaze over because of the sheer volume of it? I mean the ADR's for example are a lot of 'internal' musings that I've considered. I am a solo developer on this pro…

I think the trick is to write in a way that gets other people to read it, and in a way that's cognisant of the fact that that reading will be more akin to skimming. Gratuitous use of bullet points and bolding two or three key takeaways are the main quick hacks I use to in support of that goal.

Longer-form writing and proper prose are more useful for e.g. tutorials, but things like user stories or other reference material should really be written to be skimmable, in my opinion.

Re: Why does writing matter in remote work?

#35

I work with many people who are against writing; they never write anything and they only want to do sync meetings (phone/in person); I am on the tech team usually which makes that even more painful as 'talking through tech' is a horrible thing. Nothing sticks as everyone needs time to think about things. Inevitably, after a while, you get people losing track of things that were actually said, that were actually agree…

After a sync meeting, I find that it can be useful to note down your key takeaways in an email sent to the other party for confirmation. ("For posterity, this is what we just discussed: ...".)

Re: Why does writing matter in remote work?

#36

In my new job I do a lot of writing; documentation, architecture (ADR's), and lots of details in the user stories themselves - although those are mainly for myself. But I have a fear. What if nobody bothers to read it? What if they start reading it but just glaze over because of the sheer volume of it? I mean the ADR's for example are a lot of 'internal' musings that I've considered. I am a solo developer on this pro…

Some notes:

I'd generally try to disregard the fear that your docs won't be used. At worst, they'll allow people to determine the original design intent and reconstruct how and why the project diverged at some point after you stop working on it. As long as the docs are part of the version control scheme for the project, you should be fine. If you however are using "share drive version control" aka a bunch of copies of the documentation for each release on a network drive separate decoupled from the project, it might as well not exist. If that's the case, you need to get it in version control. Sorry that was a bit of a tangent but I had flashbacks to a previous project.

If you want people to read the documentation, make it concise. The ADRs can be verbose and logged as necessary. That's kinda the point of an ADR. They record the mindset and intent of the developer. Everything else however needs to be easy to jump into. Have a super concise summary that links to subtopics and put in the detail there.

If you want people to maintain the documentation, integrate it into the build system/CI. If you have code examples in your documentation, they need to be unit tested so that the build system will warn you when the docs are out of date. Another avenue is to associate documentation with source code so that merge checks require documentation associated with modified sections of code must be checked off before commit. Getting this right is definitely the hardest part with documentation but when done well, it is immediately evident.

Also I know I have seen articles like you mentioned but for the life of me I can't find them. If you come across them, I'd love if you could share some so that I can bookmark them.

Re: Why does writing matter in remote work?

#38
post #35

I work with many people who are against writing; they never write anything and they only want to do sync meetings (phone/in person); I am on the tech team usually which makes that even more painful as 'talking through tech' is a horrible thing. Nothing sticks as everyone needs time to think about things. Inevitably, after a while, you get people losing track of things that were actually said, that were actually agree…

After a sync meeting, I find that it can be useful to note down your key takeaways in an email sent to the other party for confirmation. ("For posterity, this is what we just discussed: ...".)

One of the most useful habits ever.

Re: Why does writing matter in remote work?

#39
post #23

I work with many people who are against writing; they never write anything and they only want to do sync meetings (phone/in person); I am on the tech team usually which makes that even more painful as 'talking through tech' is a horrible thing. Nothing sticks as everyone needs time to think about things. Inevitably, after a while, you get people losing track of things that were actually said, that were actually agree…

For most companies, the process is not the product. Having immaculate meeting notes from sync meetings 3 years ago doesn't keep the lights on.

Preventing the same discussion from taking place again and again and again does help keep the lights on though, and putting things in writing helps with that.

As does having the original reasoning for why things were done the way they were three years ago, when there's a new feature request and nobody is left of the original team.

Re: Why does writing matter in remote work?

#40

In my new job I do a lot of writing; documentation, architecture (ADR's), and lots of details in the user stories themselves - although those are mainly for myself. But I have a fear. What if nobody bothers to read it? What if they start reading it but just glaze over because of the sheer volume of it? I mean the ADR's for example are a lot of 'internal' musings that I've considered. I am a solo developer on this pro…

> But I have a fear. What if nobody bothers to read it?

This is definitely a big problem, especially in cases when reporting up the chain of command or sideways (to colleagues or other teams).

People don't read.

A big part of the reason seems to be the low expectation of value from any text. Since most writing is not well organized and rambly, people just assume it's not worth reading. And to be honest, they would be right most of the time... except when they are not.

The problem is the well thought out email that summarizes all the info about the project from past meetings that took a day to prepare, contains all the important links to documents, and describes a well thought out strategy for next steps will get just as much attention as the average non-consequential email of the same length.

Sometimes I think we need to have color coding for the hours that went into writing a piece of text, e.g. a paragraph showing in dark font indicates many hours and synthesis went into producing it (including decisions, consultations, planning, feasibility, etc), vs. a light gray text that is just a random suggestion. Such a color coding might help signal to the non-reader crowd (most people) that something is worth reading... something like nutritional facts.

Post reply on HN