Allie Proff, CPTC, is passionate about technical writing because it combines her loves of reading and writing with math and science.
She has been communicating technical knowledge for almost 20 years, whether it be in the US Navy, as a high school math teacher, or as a technical communicator for other companies.
Her aim is to help people do amazing things by connecting them with the content they need in a way they understand.
How to Set Up (and Improve) a Documentation Portal, Setting Up a (Useful!) Quality Management System Document Suite for ISO 9001 Certification
Co-presented with: Christopher Stice
Imagine being the first (and only) technical writer at a small company. You get to set everything up!
Or even if you’re a solo technical writer or in a small team with a documentation portal already set up, there are probably ways you might want to improve it.
During this session, we will go over how we set up a documentation portal from scratch accompanied by questions you can ask yourself or your team for each topic.
We’ll cover a number of considerations that go into intentionally setting up or improving a successful documentation portal: stakeholders, your content management system (even a homegrown one), writers and readers, templates and style guides, metrics, and change management.
In this session, attendees will learn:
- Six different areas to consider when setting up or improving a document portal
- Stories of one case study plus questions for you to ask yourself or your team for each topic