briandominick / codewriting

Source for Codewriting (book) and the Codewriting/Code the Docs (site/blog)
Other
50 stars 13 forks source link

Docs Tell a Story #27

Open lief-erickson opened 6 years ago

lief-erickson commented 6 years ago

General comment.

Humans are hardwired to connect to story. Back when details were passed along in oral form, it was done in the form of metaphor and story. Putting the user/reader in the position of the hero on his/her/their journey allows the reader to identify their situation and where they are in it. Good documentation will help the reader overcome the hero's obstacle and explain what the resolution was (and any next steps, if there are any).