Maybe you’re considering hiring a tech writer—or perhaps you’ve already decided to hire one, and you’re interviewing candidates. If you haven’t collaborated with a tech writing professional before, how will you approach the process? A few basic actions can help ensure a timely project launch and facilitate more effective communication among everyone involved.
Here are four essential questions to consider before you bring a technical writer onboard the project.
Are security clearance and permissions required from your company’s IT department?
Many managers are surprised by unexpected delays that occur after the project is launched. Here are two of the most common causes:
- It can take days or weeks to perform a background check or obtain security clearance for a contract employee.
- Access to certain areas of a company’s records storage or website may be restricted or available only to permanent employees.
Is the necessary equipment already in place for use by the technical writer?
- Do you plan to issue a company laptop to the technical writer? If so, ensure that the equipment is available and ready to go.
- Have you discussed the project needs with the tech writer to determine which applications might be needed? Some projects may require graphic design software; others may need only screen-capture tools.
Is there a plan to introduce the technical writer and the team they’ll be working with?
- Consider arranging a brief meeting to introduce the technical writer and the project team before the project launch.
- Allow time for a Q & A session to give all parties an idea of what to expect and provide understanding about how the team can work together effectively.
What kind of reporting style and schedule do you prefer?
Having a communication plan is essential. Some possible ways to accomplish this include:
- Weekly reports in a prescribed format
- Ongoing updates by email
- In-person meetings at scheduled intervals
I’m adaptable to any of these and other methods. Establishing good communication can save a lot of wasted time and prevent unnecessary iterations.
Do you have other questions about how to get your documentation project off to a good start? Feel free to contact me so we can talk about it!