The Dangers of Treating Product Documentation as an Afterthought
dev.to·10h·
Discuss: DEV
📝Markdown
Preview
Report Post

I once worked with a company that hired external technical writers to create content to promote their product. To do my work properly, I needed to understand how the product worked, so I checked out the existing documentation and it was complete chaos.

The documentation was incomplete, workflows were poorly explained, and most of their code snippets didn’t work. Suffice to say the documentation was not very helpful.

I had to rely on repeated one-on-one calls with their product team to understand how their product actually worked.

While the conversations were helpful and I was able to eventually do my work, they shouldn’t have been necessary. Documentation should reduce dependency, not create it. I can only imagine how many would-be customers dropped their product out of frustrati…

Similar Posts

Loading similar posts...

Keyboard Shortcuts

Navigation
Next / previous item
j/k
Open post
oorEnter
Preview post
v
Post Actions
Love post
a
Like post
l
Dislike post
d
Undo reaction
u
Recommendations
Add interest / feed
Enter
Not interested
x
Go to
Home
gh
Interests
gi
Feeds
gf
Likes
gl
History
gy
Changelog
gc
Settings
gs
Browse
gb
Search
/
General
Show this help
?
Submit feedback
!
Close modal / unfocus
Esc

Press ? anytime to show this help