Search This Blog

Wednesday, June 28, 2017


Recently, I was revising some documentation at work which was set up as frequently asked questions. I despise that format and it feels like I've wrote about it recently. The reason I despise the format has to do with when I worked at QDS. There was a major procedure - adding a X - to the system. Within a FAQ on the website, the procedure detailed the 17 steps, but within the documentation, there were more steps. I had to resolve, between the two, which was correct. Ultimately, the solution was to remove the FAQ from the website and integrate it within the 'regular' system documentation. Read about FAQs here.

Editor's Note: Dang! This situation has been described somewhere, but a search is coming up empty.

No comments: