|
Engineering is serious business and engineers are serious people.
They don't have time for tech writers who don't speak their language.
Can your technical writers advise engineers and other SMEs on:
- System architecture
- Software design
- Testing procedures & methods
- Best-practice naming conventions for:
- System components
- Software modules
- Configuration files
- Parameters
- User interface design
Do your engineers respect your technical writers and see the value in making time for them?
JBS specializes in complex, challenging projects.
JBS's technical writing team includes professionals with experience in software development, system architecture, system engineering, project management and more.
Contact JBS
Does this sound familiar?
After a grueling race to the finish you’ve delivered the new version of the system to your client on the other side of the world. The bugs have been fixed and the documents updated. You take a deep breath and go home to enjoy the weekend. Next week, back at the office you find this email in your Inbox:
Dave,
Thanx for getting the latest drop to us on time. However, we worked until VERY late Friday getting it up and running. There’s a mistake in section 12.4.3 of the Release Notes (it should be \\_177 and not \\_17). This error caused the process to crash over and over again and a TON of frustration among my team members.
There were also several sentences in the document that sounded OK at first reading but really made no sense technically - attached are my suggestions for rewriting those parts.
The software is looking good, but I’m afraid that this documentation screw-up will leave a bad taste in our mouths for a while.
Greg
Stories like this, or others where the technical writer was in a fog and merely copied-and-pasted an email from an engineer and “fixed up their English” – likely introducing errors and ambiguity –
can cost you in time, money and reputation. A writer can only ensure the accuracy and effectiveness of her technical documents if she understands the content.
Never underestimate the value of a well-written
technical document!
Contact JBS |
