GrowWithFlow conference (recap 6): Really-really technical docs
- Elisabeth Goethals
- 19 hours ago
- 2 min read
Last November, over 80 technical communicators, information architects, and documentation aficionados broadened their horizon at GrowWithFlow, Flow’s highly irregular but equally appreciated technical communication conference. Here is one of the highlights: Really-really technical documentation.
Nuts, bolts, and manuals
A high-quality product deserves a high-quality manual, and crafting one requires its own toolbox. Often companies assume that their engineers can just do the documenting—after all, they developed the product, so describing it should be a cakewalk, right?
The first challenge every engineer-turned-technical-writer faces is time: Designing and updating a good product claims most of the monthly schedule. Add in time for testing and innovation, and they’re left with precious few hours to dedicate to keeping a manual updated.
The second challenge is one of perspective: People write what they know and can have trouble placing themselves in the end-user’s (often less-technically-inclined) shoes. Engineers and developers might focus more on documenting technical specifications and less on concrete use cases and the issues a first-time user might face.
Serious machines, but simple technical docs
We want our tools and software to be user-friendly and intuitive. Why should manuals and other technical content be any different? As technical writers, we bridge the gap between product developers and end-users.
At Flow, our technical writers have a broad range of experience in different fields: we’ve worked on everything from drones, engines, and conveyor belts all the way to software for hospitals, home control systems, or digital printers. Each time, we take complex subjects and translate them into clear instructions that are well-structured and easy to follow.
We want our tools and software to be user-friendly and intuitive. Why should manuals and other technical content be any different?
However, technical writing goes beyond just content creation—we also guide you in choosing the right tools, coach you to apply consistent writing practices, and help you implement effective publishing methods. All of this ensures your users have easy access to the information they need to complete the task at hand.
It is this combination of skills that makes a technical writer a valuable part of the team and ensures your documentation is both accurate and accessible.