Want to document your Web and RESTful APIs but don’t know where to start? Me too. APIs are great but they also need documentation. I did a bit of hunting and compiled this list. It’s in no particular order of preference. I sorted them A-Z. [Get the API Documentation Template here] 21 API Documentation Tools […]
This week we created a new set of Quality Assurance Plan Templates. I sat templates as we developed more than just the MS Word template, but sample materials, and also seven pretty slick Excel spreadsheets. If you’re involved in tech writing or software testing, I think these templates will be of real value to your Quality […]
In the introduction section, identity the software you are about to install, steps to prepare for installation, running installation scripts, and post-installation tasks after the installation script has completed. In general, your installation guide will include most of the following: Introduction Choose the Installation Type Concepts Setup Pre-Installation Requirements Pre-Installation Checklist Installation and Configuring Procedure […]
Documentation plans – where do you start? Which technical document should you first write when starting to a new tech docs project? KB emailed me this question. When starting as a technical writer, it can be hard to know where to start writing, especially if many people have different documentations needs. Here’s how to get […]
Even if your MS Word documents gets corrupted, you can still repair it in Word. Here’s how. If a Word document will not open and you need to get a copy of the text within the document, try the following steps. This will help you recover the text in the document, though you may need […]
Mike Hamilton on the MadCap blog wrote an excellent tutorial on how to chunk content. We’ve covered this subject before, especially when looking at information architecture and how to write for the web. What’s interesting about Mike’s article is how he uses conditional markers to do this in MadCap Flare.
I’ve always had mixed feelings about peer reviews. What they’re done right, we all learn but like Lesson Learned review can easily degenerate into bitching sessions if not managed correctly.