: Re: Should software product release notes be in marketing voice or technical voice? (software documentation) Typically, the voice of marketing content doesn't match the voice of technical content --

Release notes should be written in the same voice as the User's Guide, online Help, and other documentation -- if they have the same audience -- because all documentation content (more than "voice") is based on audience needs, comprehension level, and purpose.

When I wrote release notes for Citrix Metaframe software, the notes had content, depth of detail, language and terminology that was appropriate for network administrators, because they were the audience. When I wrote "Read Me" files for Mac graphics software, I used language, details, and tone that was appropriate for end-uses and administrators (from a one-person graphic design shop to Boeing engineers) because that's who was going to read them.

"Technical" does not have to be dense, flat, and passive. Precision and clarity do not clash with simple and understandable; they are the same. User-friendly doesn't have to be folksy or informal.

I think the real answer is, don't be afraid to use the word "you" -- talk to the reader -- even in technical release notes. Just be sure you know who "you" is.

Load Full (0)

: There are no taboo subjects. The way you present the story. will determine of anyone wants to read it. Rape, abprtion, child molestation (Piers Anthony's Firefly was banned in dozens of countries;

@Caterina108

Load Full 0 Comments

: Should I defend my character's appearance? I'm in talks with a publisher about my comic book. In it, the main character is a hunter who hunts monsters, but in a way inspired by how real hunters

@Caterina108

Load Full 10 Comments

: People Change One thing to remember is that celebrities (and all of us for that matter) change and age with time. So what a celebrity looks like "today" may not be what she looks "now".

@Caterina108

Load Full 0 Comments

: First, really look at your audience. Define what you mean by a young adult. Normally we mean a teen, who has some concepts of adult issues but not the full toolbox to deal with them. To

: Re: Should software product release notes be in marketing voice or technical voice? (software documentation) Typically, the voice of marketing content doesn't match the voice of technical content --

More posts by @Caterina108

: There are no taboo subjects. The way you present the story. will determine of anyone wants to read it. Rape, abprtion, child molestation (Piers Anthony's Firefly was banned in dozens of countries;

: Should I defend my character's appearance? I'm in talks with a publisher about my comic book. In it, the main character is a hunter who hunts monsters, but in a way inspired by how real hunters

: People Change One thing to remember is that celebrities (and all of us for that matter) change and age with time. So what a celebrity looks like "today" may not be what she looks "now".

: First, really look at your audience. Define what you mean by a young adult. Normally we mean a teen, who has some concepts of adult issues but not the full toolbox to deal with them. To

Login to post a comment!

0 Comments

Back to top