In most cases documentation and technical writing often comes after the fact or prior to an event happening. In these cases, we see functional design specifications showing equipment functionality, or a report crafted after an event has occurred. There are cases, however, where documentation support is required during an event. For example, during testing or site visits technical writers and documentation team members act as mentors and custodians of documentation. Here are some tips on being good documentation mentors.
Support your Teammates
During testing or other events engineers or members or other teams require reference documentation or the creation of documentation at a moment’s notice. It is here that a documentation mentor can offer support by gathering controlled copy reference material such as drawings, test documents, or OEMs to support them. A member of a documentation team knows where this material is and can access, prepare, and distribute it much quicker.
Be the Bastion of Process
In high pressure situations those not fully familiar with documentation processes will likely step around them to get the job done quickly. Documentation team members are well versed in company documentation processes such as transmittal, control of records, and revision control. As a documentation mentor, step in and offer to help guide them through process to achieve their goals so no issues arise later.
Be Ready Clear your Desk
Supporting other teams as a documentation mentor can sometimes mean fast approaching assignments with short turnaround times. Work within your team and shuffle work so you can be ready to support these tasks as they come.
IDS is AKA’s dedicated documentation team, and with over 20 years of innovation and R&D at AKA, the IDS team is well suited to handle just about any situation. The IDS team are mentors to all of AKA and are there to support any task whether it be internal or from a client.