: Re: How can we make compiling release notes less chaotic? Each of our software releases is accompanied by a set of release notes, which include short descriptions of the following: new features,

First off, technical non-writers make better technical writers, than non-technical writers do. They usually can write in a way mostly understandable to layman and factually correct (as opposed to non-technical writers who'll often write something perfectly clear, but completely wrong), they just need to be asked to do so - they won't, if they don't know they should!

Instead of non-technical people assembling the notes, have technical people tasked with assembling them in a relatively reader-friendly manner. Best, if everyone in the team wrote short release notes on everything they did in person, every bug they filed, asked to explain it in relatively non-technical manner (typical to release notes - they know what release notes are). It's 10 minutes of work per month, and you have a good preliminary draft almost complete.

Only then have the non-technical writer edit the draft, making it pretty, correcting errors or smoothing out still too technical language. If something is hard to understand, consult, perform the usual back-and-forth, but the number of these cases should drop to 2-3 per iteration from dozens. Simply, instead of asking the non-technical writers to reach across the chasm to the professionals, have them meet halfway - essentially, everyone becomes the writer, but you're getting one good editor.

Load Full (0)

: In my case the answer is: you write it all the time. You write it down in the little breaks but you create in between. I tend to write while on the bus, or at work in between tasks.

@Deb2945533

Load Full 0 Comments

: How to write a reminder LinkedIn email to a stranger? I emailed some people on LinkedIn asking them some questions about their expertise. Most of them responded back and asked me to send my

@Deb2945533

Load Full 2 Comments

: Seems like step 2 of the 3-step method of coming up with the title. First step: you compress the story into a half-page summary, that catches the essentials, piques interests, and so on.

@Deb2945533

Load Full 0 Comments

: How To Cite Francis Bacon's Of Simulation and Dissimulation Essay I have to write a paper that defines the word "simulation". As part of my paper, for historical reasons I've decided to use

: Re: How can we make compiling release notes less chaotic? Each of our software releases is accompanied by a set of release notes, which include short descriptions of the following: new features,

More posts by @Deb2945533

: In my case the answer is: you write it all the time. You write it down in the little breaks but you create in between. I tend to write while on the bus, or at work in between tasks.

: How to write a reminder LinkedIn email to a stranger? I emailed some people on LinkedIn asking them some questions about their expertise. Most of them responded back and asked me to send my

: Seems like step 2 of the 3-step method of coming up with the title. First step: you compress the story into a half-page summary, that catches the essentials, piques interests, and so on.

: How To Cite Francis Bacon's Of Simulation and Dissimulation Essay I have to write a paper that defines the word "simulation". As part of my paper, for historical reasons I've decided to use

Login to post a comment!

0 Comments

Back to top