Click here to Skip to main content
15,116,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 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
Member 798912213-Aug-19 21:55
MemberMember 798912213-Aug-19 21:55 
GeneralCode Samples? Pin
PeejayAdams11-Aug-19 23:32
MemberPeejayAdams11-Aug-19 23:32 
GeneralRe: Code Samples? Pin
Slacker00712-Aug-19 2:12
professionalSlacker00712-Aug-19 2:12 
GeneralRe: Code Samples? Pin
PeejayAdams12-Aug-19 2:22
MemberPeejayAdams12-Aug-19 2:22 
GeneralRe: Code Samples? Pin
Chris Maunder12-Aug-19 4:06
cofounderChris Maunder12-Aug-19 4:06 
GeneralRe: Code Samples? Pin
Member 798912213-Aug-19 2:08
MemberMember 798912213-Aug-19 2:08 
AnswerOther : it shows how it looks like / it shows/explains how it works Pin
Ralf Meier11-Aug-19 23:05
professionalRalf Meier11-Aug-19 23:05 
GeneralRe: Other : it shows how it looks like / it shows/explains how it works Pin
ronlease12-Aug-19 3:41
professionalronlease12-Aug-19 3:41 
Exactly! Documentation should focus on the why much more than the how. What assumptions were made? What are the general inputs and outputs? What's the life expectancy of the application? What critical technologies are involved? Stuff like that. If organizations need documentation to explain the code itself (at least at a low level), then code is quite likely badly written.
GeneralBug - Spelling mistake Pin
Amit Joshi CP11-Aug-19 22:14
MemberAmit Joshi CP11-Aug-19 22:14 
GeneralOther [along with standard options] Pin
Amit Joshi CP11-Aug-19 22:18
MemberAmit Joshi CP11-Aug-19 22: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.