Technical Writing
User Guides, Knowledge Base, FAQs
Support your users contextually while they are using your application and provide a complete resource to cover all use cases. Including:
​
-
Audit - Find gaps in your support documentation with a full audit of current support materials
-
Article Creation - Build a new Knowledge Base or FAQs page with brand new articles or user guides to cover processes
-
Proofing and editing - Make sure your current content is in line with new content
-
Updates and Maintenance - Keep content up-to-date with every new feature release or update
​
Whether you already have a knowledge base and just need updates and maintenance, or whether you are starting from scratch, I have a service to suit you.
Updates and Maintenance
Ongoing maintenance of support materials to cover new features and software updates including:
-
Replacing out-of-date screenshots
-
Updating revised company terminology or branding
-
Adding new processes into existing documentation
-
Clarifying procedures based on user feedback
Training and Resources
Training materials including templates and guidelines so you can easily perform your own updates.
-
Complete database of your support articles, so they can be easily maintained and updated
-
Style guidelines to keep your copy consistent
-
Customized FAQ templates
-
An easy-to-follow updates and maintenance toolkit, so that anyone on your team can take over the process
Other Technical Writing Services
Synthesize and Organize - I will take your raw data or subject matter know-how and organize it into a clear and understandable document e.g. Sales Playbooks, Lesson Write-Ups, Storyboards, Manuals, etc.
Proofing and Editing - Let me review your presentations, tutorials or proposals to ensure they are 100% clear and error-free. I will use localization, inclusion and accessibility practices to make sure your documentation is fit for any audience.