Click here to Skip to main content
14,548,230 members

The Insider News

   

The Insider News is for breaking IT and Software development news. Post your news, your alerts and your inside scoops. This is an IT news-only forum - all off-topic, non-news posts will be removed. If you wish to ask a programming question please post it here.

Get The Daily Insider direct to your mailbox every day. Subscribe now!

 
GeneralRe: Hacker brings video to audio cassette tape Pin
Member 79891226-Apr-20 12:52
MemberMember 79891226-Apr-20 12:52 
GeneralRe: Hacker brings video to audio cassette tape Pin
Mark_Wallace6-Apr-20 19:55
MemberMark_Wallace6-Apr-20 19:55 
GeneralRe: Hacker brings video to audio cassette tape Pin
MadMyche7-Apr-20 2:36
mveMadMyche7-Apr-20 2:36 
NewsGoogle’s Technical Writing Guide Pin
Kent Sharkey6-Apr-20 8:31
staffKent Sharkey6-Apr-20 8:31 
GeneralRe: Google’s Technical Writing Guide Pin
Greg Utas6-Apr-20 9:07
professionalGreg Utas6-Apr-20 9:07 
GeneralRe: Google’s Technical Writing Guide Pin
Mark_Wallace6-Apr-20 9:54
MemberMark_Wallace6-Apr-20 9:54 
GeneralRe: Google’s Technical Writing Guide Pin
CHill607-Apr-20 6:33
mveCHill607-Apr-20 6:33 
GeneralRe: Google’s Technical Writing Guide Pin
Mark_Wallace7-Apr-20 10:05
MemberMark_Wallace7-Apr-20 10:05 
CHill60 wrote:
These amendments include: taking out the Author, removing the Version numbering, even removing the corporate frontispiece.
If it were only the author and versioning being removed, it would likely be a case of someone wanting to take credit for your work (which happens a lot), but if the branding has been removed, there are two typical reason:

0: A customer is going to put their own branding on it.

1: The company is up for sale, and you're not allowed to see the version with the new branding.

The fact that it's a ToR doc doesn't lend itself to either option, but it perhaps explains why the bullets were converted to normal prose -- bullets are for people who need to follow a process; ToR docs are for people who need to understand the process (which is probably also why they strike you as being wooly).

Just set in you mind that you're writing for someone who isn't experienced in what you do.  Too much detail, and their eyes will glaze over, because they're not interested in getting into too much technical detail, at that point, because it's up to them to decide the details, later.

So, even if you think you have the processes nailed, you need to soften the text to suit their role -- they don't need to be told step-by-step what to do, they need to be given enough overviews so that they, in discussions with other involved parties (who also need to provide input, because it affects their workload, too), can decide on steps that work for everyone.

And never get upset if someone changes your text, in a business context, or you'll live a short, unhappy life with a violent heart attack at the end of it.
I wanna be a eunuchs developer! Pass me a bread knife!

GeneralRe: Google’s Technical Writing Guide Pin
CHill607-Apr-20 22:14
mveCHill607-Apr-20 22:14 
GeneralRe: Google’s Technical Writing Guide Pin
Nelek7-Apr-20 10:33
protectorNelek7-Apr-20 10:33 
GeneralRe: Google’s Technical Writing Guide Pin
Mark_Wallace7-Apr-20 23:06
MemberMark_Wallace7-Apr-20 23:06 
NewsWork flow of diagnosing memory performance issues – Part 0 Pin
Kent Sharkey6-Apr-20 8:01
staffKent Sharkey6-Apr-20 8:01 
GeneralRe: Work flow of diagnosing memory performance issues – Part 0 Pin
Mark_Wallace6-Apr-20 20:00
MemberMark_Wallace6-Apr-20 20:00 
NewsWindows 10 security: Change your password to a PIN, says Microsoft Pin
Kent Sharkey6-Apr-20 8:01
staffKent Sharkey6-Apr-20 8:01 
GeneralRe: Windows 10 security: Change your password to a PIN, says Microsoft Pin
Greg Utas6-Apr-20 9:05
professionalGreg Utas6-Apr-20 9:05 
GeneralRe: Windows 10 security: Change your password to a PIN, says Microsoft Pin
Brisingr Aerowing6-Apr-20 12:03
professionalBrisingr Aerowing6-Apr-20 12:03 
GeneralRe: Windows 10 security: Change your password to a PIN, says Microsoft Pin
Mark_Wallace6-Apr-20 20:02
MemberMark_Wallace6-Apr-20 20:02 
GeneralRe: Windows 10 security: Change your password to a PIN, says Microsoft Pin
David O'Neil6-Apr-20 15:41
professionalDavid O'Neil6-Apr-20 15:41 
GeneralRe: Windows 10 security: Change your password to a PIN, says Microsoft Pin
Dan Neely7-Apr-20 2:25
MemberDan Neely7-Apr-20 2:25 
GeneralRe: Windows 10 security: Change your password to a PIN, says Microsoft Pin
David O'Neil7-Apr-20 3:52
professionalDavid O'Neil7-Apr-20 3:52 
GeneralRe: Windows 10 security: Change your password to a PIN, says Microsoft Pin
Dan Neely7-Apr-20 4:13
MemberDan Neely7-Apr-20 4:13 
GeneralRe: Windows 10 security: Change your password to a PIN, says Microsoft Pin
Super Lloyd7-Apr-20 7:11
MemberSuper Lloyd7-Apr-20 7:11 
GeneralRe: Windows 10 security: Change your password to a PIN, says Microsoft Pin
Mark_Wallace6-Apr-20 20:07
MemberMark_Wallace6-Apr-20 20:07 
GeneralRe: Windows 10 security: Change your password to a PIN, says Microsoft Pin
Richard Andrew x647-Apr-20 10:06
professionalRichard Andrew x647-Apr-20 10:06 
GeneralRe: Windows 10 security: Change your password to a PIN, says Microsoft Pin
Bernhard Hiller8-Apr-20 3:19
MemberBernhard Hiller8-Apr-20 3:19 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.