How to Fix Errors in Technical Documents Automatically
You can setup MS Word so that it automatically fixes mistakes you make in your documents. To automatically detect and correct typos, misspelled words, and incorrect capitalization, use the AutoCorrect...
View ArticleClik here to view.
Microsoft Word v Adobe Framemaker
Which is better for writing long technical documents? Adobe FrameMaker or MS Word? I’ve prepared a list of the strengths and weaknesses of each tool. Take a look and tell me what you think. And which...
View ArticleUsing AutoCorrect To Fix Mistakes In Technical Documents
Here are three ways to use AutoCorrect to fix errors in your technical documents: Capitalization options – AutoCorrect can capitalize the first word in a sentence, the names of days of the week, the...
View ArticleClik here to view.
Difference Between Operations Manuals & Procedures Guides
What’s the difference between an Operations Manual and a Procedures Guide? At first glance, it’s easy to see the confusion as both contain procedures that need to be followed. However, if we look at...
View ArticleHow do you know whether you’re writing well?
How do you know whether you are writing well? There’s only one test that really matters: when your audience understands your information and is moved to act in accordance with your goals. But how will...
View ArticleClik here to view.
The 10 Commandments of Software Maintenance Plans
What’s the best way to write a Software Maintenance plan? Software Maintenance Plans are different than other technical documents in that the focus is on how to modify software AFTER it has been...
View ArticleClik here to view.
How to write a test case
One of the difficulties in writing your first test case is that it’s hard to know where to start. Writing test cases is not that difficult if you understand who you’re writing for and what you’re...
View ArticleClik here to view.
How to make detailed Business Process Flowcharts easier to read
Isn’t the advantage of creating process flowcharts to help the reader see how it works instead of having to read the MS Word document? But what happens if the process is so complex that the diagram...
View ArticleHow to write a software documentation plan
What is a software documentation plan? This is a project plan for the technical documents you plan to write for the next software release. Like a standard project plan it captures the resources,...
View ArticleOperations Plan: The Definitive Guide
Want to write an Operations Guide? This tutorial explains how to write your first operations manual. It helps you get started, suggests how to format the document, create the table of contents and what...
View ArticleHow to Write a Better System Administration Guide
What do System Administration Guides and Mozart have in common? There’s a scene in the movie Amadeus where the Emperor asks Mozart to take out the boring notes. He found it too long. “Cut out some...
View ArticleSOP v Work Instructions v Procedures
How can you tell if a document is a SOP, Procedure, or Work Instruction? Also, what are the connections between each of these documents? Is one more important than the other? Do you need to write an...
View ArticleRelease Notes: 13 Mistakes to Avoid
It’s easy to overlook the importance of release notes. But when customers want to know exactly what a specific parameter does, it’s the release notes that often turn too. Why? Remember, for very large...
View ArticleRelease Notes – How to Write ‘Known Issues’
This week we look at how to document known issues in release notes. The Release Notes web page on the NuGet site offers good examples of how to document known issues in release notes. We’re going to...
View ArticleSample Text for Writing Release Notes Enhancements
An enhancement is a new feature, or an improvement to a current feature, included in the current release. To help the reader understand the enhancement, describe: Where the enhancement is located in...
View ArticleHow to write Enhancements for Release Notes
What do you need to include in your enhancement release notes? At a minimum, you need to cover the following: Description – identify the new enhancement. Avoid the words new, enhancement, or feature in...
View ArticleInstallation Guide Checklist: Sample Template For Technical Writers
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...
View ArticleTechnical Documents Reviews: How to Perform a ‘Post Mortem’
After every major release, do a post mortem of your technical documentation and look at how you can improve team morale, writing process, document reviews, and the documentation product. Post-mortems...
View ArticleHow to write documents for SaaS web applications
SaaS and web-based applications are becoming more popular as they replace desktop or network installations. How you document them is mostly the same as documenting traditional but there are some...
View ArticleTechnical Documents Reviews: Mentoring Indian Tech Writers
Does your technical writing team have offices in Bangalore? Many US software companies are moving technical writing projects to India, Romania, Singapore and Poland. I often help these teams setup...
View Article