Best practices for creating tutorials and FAQs
June 18, 2014 5:43 AM Subscribe
I work for a small web hosting company and have been tasked with creating user tutorials and a general FAQ section. Please give me your best resources, tips, and ideas on how to best go about doing this.
posted by jammy to Computers & Internet (11 answers total) 20 users marked this as a favorite
I have already begun creating style sheets for them all, so as to present a unified aesthetic (e.g., serif fonts for titles and formal names, sans-serif for body text).
I have also been creating screenshots of our user control panel.
As far as general writing style goes, I am trying to be as straightforward and to the point as possible, keeping jargon to a minimum, avoiding digressions by creating/linking to substantial items deserving of their own pages, etc.
If you have created such, please tell me what you did that worked best, what didn't.
If you have ever used a web host's online FAQ or support, tell me what you liked, what you didn't.