Note-taking is an important part of a technical communication process. A typical project can move from the account manager to the project manager, and then onto the technical communicator. Sharing information gathered at client meetings with project team members is often done through internal meetings and phone calls, handover documents written in Word, and other related… Read more »
Tag: tools
Creating documentation in a Continuous Integration/Continuous Delivery environment
Creating user documentation and online Help in a Continuous Integration/Continuous Delivery environment can be challenging for technical communicators and developers.
Cutting and pasting content into Word documents – Is there a better way?
Earlier this week, we were helping a large company finalise a bid document where they were required to use a Word file sent by their client. This involved taking content from the company’s repository of standard documents on SharePoint, and from emails, plus writing down information provided verbally by the Subject Matter Experts. The bid writing team had to cut the relevant content from… Read more »
Is it possible for Technical Authors to write content more quickly?
Approximately 50% of a Technical Author’s day is spent writing. However, when Technical Publications teams look for efficiencies, they tend to focus on the 50% of time spent on non-writing activities, such as researching, reviewing and planning. They assume the content itself cannot be written more quickly. To an extent, they are right, as the querty qwerty keyboard… Read more »
SharePoint for documentation projects
Most of the Technical Authors I have met don’t have a good thing to say about Microsoft SharePoint. In many ways, it represents how not to publish content online. It is seen as encouraging people to move print-optimised documents (Blobs) around, rather than units of content (Chunks), and users are typically left to rely on search… Read more »