End User Documentation. What works?

allison_slaught

I've seen a wide range of documentation... My typical documentation includes quite a bit (listed below) but end user documentation is usually developed by other SMEs. Thanks to the "great resignation" many are seeing higher turnover so I'm finding the need for more and better end-user documentation. I'd appreciate whatever help this community can provide in this area--examples of what worked well for you, tips, other technologies you've paired it with ('walk me' is one I heard of in a user group years back). Please feel free to email examples to me at allison.slaught@anaplan.com

 

My technical documentation typically includes:

-a few select high-level slides focused on dimensionality, roles/personas, key conventions (e.g., FX approach), information around where the model won't scale, and model standards

-high-level model schemas

-roll-forward documentation (e.g., how to advance the model every week/month/quarter and then separately for year)

-in-model documentation within notes with consistent use of naming conventions

-end user dashboards designed with usability in mind