Click here to Skip to main content
15,442,754 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!

 
NewsA software developer’s guide to technical writing Pin
Kent Sharkey18-Aug-22 11:16
staffKent Sharkey18-Aug-22 11:16 
GeneralRe: A software developer’s guide to technical writing Pin
David O'Neil18-Aug-22 12:48
professionalDavid O'Neil18-Aug-22 12:48 
GeneralRe: A software developer’s guide to technical writing Pin
Marc Clifton18-Aug-22 14:45
mvaMarc Clifton18-Aug-22 14:45 
JokeRe: A software developer’s guide to technical writing Pin
Peter_in_278018-Aug-22 16:17
professionalPeter_in_278018-Aug-22 16:17 
GeneralRe: A software developer’s guide to technical writing Pin
Daniel Pfeffer18-Aug-22 20:01
professionalDaniel Pfeffer18-Aug-22 20:01 
GeneralRe: A software developer’s guide to technical writing Pin
Nelek18-Aug-22 22:29
protectorNelek18-Aug-22 22:29 
GeneralRe: A software developer’s guide to technical writing Pin
Chris Maunder19-Aug-22 1:27
cofounderChris Maunder19-Aug-22 1:27 
GeneralRe: A software developer’s guide to technical writing Pin
Gary Wheeler19-Aug-22 2:16
MemberGary Wheeler19-Aug-22 2:16 
The author completely missed the most fundamental principle in writing, especially technical writing: Consider your audience. If you fail to recognize and write to the needs of those reading your work, the quality of the work is immaterial.

Programmers will expect technical details, code snippets, block diagrams, and so on. Technical managers need advantages, disadvantages, case studies, technical debt effects and such so that they can make decisions about how your topic relates to their requirements. Business managers need the minimum amount of technical information so that they don't make fools of themselves. They need information on costs, scheduling, and other business concerns.

All of these lead to very different documents or presentations.
Software Zen: delete this;

GeneralRe: A software developer’s guide to technical writing Pin
jeron122-Aug-22 7:01
Memberjeron122-Aug-22 7:01 
NewsAlmost half of businesses are struggling with cloud costs Pin
Kent Sharkey18-Aug-22 11:16
staffKent Sharkey18-Aug-22 11:16 
GeneralRe: Almost half of businesses are struggling with cloud costs Pin
Nelek18-Aug-22 22:16
protectorNelek18-Aug-22 22:16 
GeneralRe: Almost half of businesses are struggling with cloud costs Pin
Daniel Pfeffer18-Aug-22 23:08
professionalDaniel Pfeffer18-Aug-22 23:08 
GeneralRe: Almost half of businesses are struggling with cloud costs Pin
#realJSOP20-Aug-22 0:23
mva#realJSOP20-Aug-22 0:23 
NewsTalking to your customers: a disruptive Agile framework Pin
Kent Sharkey18-Aug-22 9:01
staffKent Sharkey18-Aug-22 9:01 
NewsGoogle will downrank click-farm garbage and aggregators to improve search results Pin
Kent Sharkey18-Aug-22 8:46
staffKent Sharkey18-Aug-22 8:46 
GeneralRe: Google will downrank click-farm garbage and aggregators to improve search results Pin
Nelek18-Aug-22 9:11
protectorNelek18-Aug-22 9:11 
GeneralRe: Google will downrank click-farm garbage and aggregators to improve search results Pin
maze319-Aug-22 0:23
professionalmaze319-Aug-22 0:23 
NewsI have complicated feelings about TDD Pin
Kent Sharkey18-Aug-22 8:46
staffKent Sharkey18-Aug-22 8:46 
GeneralRe: I have complicated feelings about TDD Pin
Marc Clifton18-Aug-22 14:49
mvaMarc Clifton18-Aug-22 14:49 
NewsGoogle teaches robots to serve humans – with large language models the key Pin
Kent Sharkey18-Aug-22 8:46
staffKent Sharkey18-Aug-22 8:46 
GeneralRe: Google teaches robots to serve humans – with large language models the key Pin
Nelek18-Aug-22 9:10
protectorNelek18-Aug-22 9:10 
NewsSoftware developer cracks Hyundai car security with Google search Pin
Kent Sharkey18-Aug-22 8:31
staffKent Sharkey18-Aug-22 8:31 
GeneralRe: Software developer cracks Hyundai car security with Google search Pin
Nelek18-Aug-22 9:07
protectorNelek18-Aug-22 9:07 
GeneralRe: Software developer cracks Hyundai car security with Google search Pin
MarkTJohnson19-Aug-22 3:37
professionalMarkTJohnson19-Aug-22 3:37 
GeneralRe: Software developer cracks Hyundai car security with Google search Pin
obermd19-Aug-22 4:23
Memberobermd19-Aug-22 4:23 

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.