10 myths about API documentation
Exit Survey
100%
You must read source code to write API docs.
Generally true
Generally false
Other
You'll need to extrapolate sample code from one language to create code samples in another.
Generally true
Generally false
Other
You must be a former engineer to be competitive in the API doc space.
Generally true
Generally false
Other
Technical writers usually create the API reference content (e.g., OpenAPI spec, Javadoc).
Generally true
Generally false
Other
Almost all job interviewers care about, when it comes to API doc jobs, is technical know-how.
Generally true
Generally false
Other
Developers can and will write docs if you implement a docs-as-code process.
Generally true
Generally false
Other
Because their role aligns with the audience, with API docs, developers are most suited to be the ones writing for other developers.
Generally true
Generally false
Other
"API documentation" and "developer documentation" are synonymous.
Generally true
Generally false
Other
Docs that look good *are* good.
Generally true
Generally false
Other
People will respect you more if the word "writer" isn't in your job title.
Generally true
Generally false
Other
Any other comments or feedback about these myths? Are there myths I didn't explore here?
Done
Powered by
QuestionPro
Report Abuse
Create Your First Online Survey
Create a Survey
Loading...
close
drag_indicator
close
Yes
Cancel
Continue
Answer Question
Continue Without Answering
Keep Data
Discard
close
drag_indicator
highlight_off
Loading...