Click here to Skip to main content
15,917,971 members

Survey Results

What makes great documentation?

Survey period: 12 Aug 2019 to 19 Aug 2019

Great docs can convince us to use a product. Bad docs just make our lives painful.

OptionVotes% 
It contains code samples50872.78
It includes step-by-step instructions to complete specific tasks42460.74
It provides information targeted towards novice users33648.14
It provides information targeted towards advanced users30643.84
It includes a walk-through of a sample application31745.42
It lists common API calls31845.56
Is comprehensive and covers every possible scenario (within reason)19828.37
It provides a quick overview of the key points in the documentation39857.02
Other (please comment)486.88
Respondents were allowed to choose more than one answer; totals may not add up to 100%

View optional text answers (49 answers)


 
GeneralRe: The Premise is wrong Pin
Ravi Bhavnani13-Aug-19 15:39
professionalRavi Bhavnani13-Aug-19 15:39 
GeneralRe: The Premise is wrong Pin
Sander Rossel12-Aug-19 21:48
professionalSander Rossel12-Aug-19 21:48 
GeneralRe: The Premise is wrong Pin
Ravi Bhavnani13-Aug-19 15:37
professionalRavi Bhavnani13-Aug-19 15:37 
GeneralRe: The Premise is wrong Pin
Sander Rossel13-Aug-19 19:55
professionalSander Rossel13-Aug-19 19:55 
GeneralRe: The Premise is wrong Pin
kalberts13-Aug-19 21:22
kalberts13-Aug-19 21:22 
GeneralRe: The Premise is wrong Pin
Sander Rossel14-Aug-19 1:49
professionalSander Rossel14-Aug-19 1:49 
GeneralRe: The Premise is wrong Pin
kalberts13-Aug-19 20:55
kalberts13-Aug-19 20:55 
GeneralCode Samples? Pin
PeejayAdams11-Aug-19 22:32
PeejayAdams11-Aug-19 22:32 
Not sure why you'd ever put them in documentation but there ought to be a law that says they should appear in sales brochures.
Whenever you find yourself on the side of the majority, it is time to pause and reflect. - Mark Twain

GeneralRe: Code Samples? Pin
Slacker00712-Aug-19 1:12
professionalSlacker00712-Aug-19 1:12 
GeneralRe: Code Samples? Pin
PeejayAdams12-Aug-19 1:22
PeejayAdams12-Aug-19 1:22 
GeneralRe: Code Samples? Pin
Chris Maunder12-Aug-19 3:06
cofounderChris Maunder12-Aug-19 3:06 
GeneralRe: Code Samples? Pin
kalberts13-Aug-19 1:08
kalberts13-Aug-19 1:08 
AnswerOther : it shows how it looks like / it shows/explains how it works Pin
Ralf Meier11-Aug-19 22:05
mveRalf Meier11-Aug-19 22:05 
GeneralRe: Other : it shows how it looks like / it shows/explains how it works Pin
ronlease12-Aug-19 2:41
professionalronlease12-Aug-19 2:41 
GeneralBug - Spelling mistake Pin
Amit Joshi CP11-Aug-19 21:14
Amit Joshi CP11-Aug-19 21:14 
GeneralOther [along with standard options] Pin
Amit Joshi CP11-Aug-19 21:18
Amit Joshi CP11-Aug-19 21:18 

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.