Click here to Skip to main content
15,905,614 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 Bhavnani14-Aug-19 5:44
professionalRavi Bhavnani14-Aug-19 5:44 
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 
I worked on a project in need of a record management library. It would have to be open source, as we were going to extend it significantly. We found one that - according to the description - fufilled all our needs, so we got hold of it. Fortunately, it didn't cost us any money. The code was well commented, each function wiht a (presumably) descriptive heading, comments before loops and other control structs, and lots of end-of-line comments. But I can't comment on the quality of the code: It was all in French. All variable names were in French, too. None of the project members could read French.

So we had to go on searching for another library. Maybe we threw out the best alternative because of its comments. Maybe variable names in English and no comments at all would have made us go for it. And I didn't feel comfortable with the alternative that we settled on.
GeneralCode Samples? Pin
PeejayAdams11-Aug-19 22:32
PeejayAdams11-Aug-19 22:32 
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.