Click here to Skip to main content
14,265,813 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 samples49772.87
It includes step-by-step instructions to complete specific tasks41560.85
It provides information targeted towards novice users32848.09
It provides information targeted towards advanced users29743.55
It includes a walk-through of a sample application31345.89
It lists common API calls31245.75
Is comprehensive and covers every possible scenario (within reason)19027.86
It provides a quick overview of the key points in the documentation38957.04
Other (please comment)476.89
Respondents were allowed to choose more than one answer; totals may not add up to 100%

View optional text answers (48 answers)
Vote now!

 
GeneralConsidering the audience, part 2 Pin
Gary R. Wheeler16-Aug-19 14:31
memberGary R. Wheeler16-Aug-19 14:31 
GeneralProvides an outside-in view Pin
Amarnath S14-Aug-19 5:02
professionalAmarnath S14-Aug-19 5:02 
GeneralAll of the Above Pin
Sammuel Miranda13-Aug-19 8:47
professionalSammuel Miranda13-Aug-19 8:47 
GeneralIt draws "the big picture", showing the architecture - how pieces fit together Pin
Member 798912213-Aug-19 1:02
memberMember 798912213-Aug-19 1:02 
GeneralRe: It draws "the big picture", showing the architecture - how pieces fit together Pin
MikeTheFid13-Aug-19 4:45
memberMikeTheFid13-Aug-19 4:45 
GeneralIt exists PinPopular
Member 798912213-Aug-19 0:43
memberMember 798912213-Aug-19 0:43 
GeneralRe: It exists Pin
Chris Maunder13-Aug-19 3:18
adminChris Maunder13-Aug-19 3:18 
GeneralDepends on the audience Pin
CHill6012-Aug-19 23:13
protectorCHill6012-Aug-19 23:13 
GeneralRe: Depends on the audience Pin
Chris Maunder13-Aug-19 3:17
adminChris Maunder13-Aug-19 3:17 
GeneralRe: Depends on the audience Pin
Rick York13-Aug-19 13:25
mveRick York13-Aug-19 13:25 
GeneralRe: Depends on the audience Pin
CHill6014-Aug-19 0:46
protectorCHill6014-Aug-19 0:46 
GeneralIt's 2019. I m looking for video/gif/screen shots in example Pin
Anurag Gandhi12-Aug-19 8:55
professionalAnurag Gandhi12-Aug-19 8:55 
GeneralRe: It's 2019. I m looking for video/gif/screen shots in example Pin
CHill6012-Aug-19 23:11
protectorCHill6012-Aug-19 23:11 
GeneralRe: It's 2019. I m looking for video/gif/screen shots in example Pin
jackbrownii13-Aug-19 5:22
professionaljackbrownii13-Aug-19 5:22 
GeneralRe: It's 2019. I m looking for video/gif/screen shots in example Pin
Marc Clifton13-Aug-19 8:06
protectorMarc Clifton13-Aug-19 8:06 
GeneralRe: It's 2019. I m looking for video/gif/screen shots in example Pin
Member 798912213-Aug-19 20:42
memberMember 798912213-Aug-19 20:42 
AnswerOther - Overview of what the application/framework/library is able to do. Pin
Member 1125611712-Aug-19 7:46
memberMember 1125611712-Aug-19 7:46 
GeneralOrganized, easily searchable, indexed, table of contents, reference links, UP TO DATE, and I can add my own comments! Pin
Marc Clifton12-Aug-19 3:03
protectorMarc Clifton12-Aug-19 3:03 
GeneralRe: Organized, easily searchable, indexed, table of contents, reference links, UP TO DATE, and I can add my own comments! Pin
Member 798912213-Aug-19 1:16
memberMember 798912213-Aug-19 1:16 
GeneralThe Premise is wrong PinPopular
#realJSOP11-Aug-19 23:22
mve#realJSOP11-Aug-19 23:22 
PraiseRe: The Premise is wrong Pin
Slacker00712-Aug-19 1:08
professionalSlacker00712-Aug-19 1:08 
GeneralRe: The Premise is wrong Pin
Ryan Peden12-Aug-19 3:03
staffRyan Peden12-Aug-19 3:03 
GeneralRe: The Premise is wrong Pin
Chris Maunder12-Aug-19 3:05
adminChris Maunder12-Aug-19 3:05 
GeneralRe: The Premise is wrong Pin
#realJSOP12-Aug-19 3:16
mve#realJSOP12-Aug-19 3:16 
GeneralRe: The Premise is wrong Pin
Chris Maunder13-Aug-19 3:30
adminChris Maunder13-Aug-19 3:30 

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.