So, you want to write release notes but don’t know where to start? Well pull you a chair and let me give you the lowdown. Download – Release Notes template with sample text. Introduce the release notes with text such as the following: These release notes provide information about the documentation for <your product> <version […]
One of the threads on LinkedIn is how to write technical documentation for APIs. It’s been many years since I’ve documented an API (Java & Oracle) so if you have any thoughts on the best way to do this, then please jump in. An application programming interface (API) is an interface implemented by a software […]
I got this email during the week. The question was: is it worth the time and money to take a technical writing course? “I’ve been reading articles about Technical Writing and I’m thinking about a change in career. I’ve worked as a non-degreed Quality Engineer in the manufacturing industries. Writing quality documentations and SOPs was […]
Master templates let you control the format and positioning of every component in your FrameMaker documents.
In plain English this means that if you setup a footer as Arial, size 10, and then apply it to the main document, all footers will appear in this font and this size. Sounds good!