10 myths about API documentation - Dashboard
1,557
visibility Viewed
30
Total Responses
30
flag Completed
100%
timelapse Completion Rate
0
do_not_disturb_on Dropouts
9 min
access_time Average Time
 
Countries Responses
US 33.33%
IN 16.67%
AU 10.00%
CA 10.00%
AT 3.33%
NZ 3.33%
PL 3.33%
BY 3.33%
CN 3.33%
GB 3.33%
Unknown 3.33%
HK 3.33%
AM 3.33%
Total 100.00%
You must read source code to write API docs.
Answer Count Percent
20% 40% 60% 80% 100%
Generally true 13 43.33%
Generally false 17 56.67%
Other 0 0%
Total 30 100 %
You must read source code to write API docs. - Text Data for Other
You'll need to extrapolate sample code from one language to create code samples in another.
Answer Count Percent
20% 40% 60% 80% 100%
Generally true 5 17.24%
Generally false 22 75.86%
Other 2 6.9%
Total 29 100 %
Youll need to extrapolate sample code from one language to create code samples in another. - Text Data for Other
10/03/2019 45699406 it's not a bad approach.
You must be a former engineer to be competitive in the API doc space.
Answer Count Percent
20% 40% 60% 80% 100%
Generally true 7 23.33%
Generally false 23 76.67%
Other 0 0%
Total 30 100 %
You must be a former engineer to be competitive in the API doc space. - Text Data for Other
Technical writers usually create the API reference content (e.g., OpenAPI spec, Javadoc).
Answer Count Percent
20% 40% 60% 80% 100%
Generally true 9 30%
Generally false 21 70%
Other 0 0%
Total 30 100 %
Technical writers usually create the API reference content (e.g., OpenAPI spec, Javadoc). - Text Data for Other
Almost all job interviewers care about, when it comes to API doc jobs, is technical know-how.
Answer Count Percent
20% 40% 60% 80% 100%
Generally true 14 46.67%
Generally false 15 50%
Other 1 3.33%
Total 30 100 %
Almost all job interviewers care about, when it comes to API doc jobs, is technical know-how. - Text Data for Other
Powered by QuestionPro