Want to improve the quality of the enhancements in your Release Notes? Here are seven ways. Download: Release Notes template package with 2 pre-formatted templates in MS Word. Download Now for $7.99- Buy Here! Learn more about these Release Notes Templates Enhancement Identifier Provide the reference number for the enhancement, such as Salesforce 12345. Business value […]
How to write documents for SaaS web applications
May 14, 2015 By
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 difference. Let’s take a look. Registration – explain how to set up the account, register an account, common setup issues, and troubleshooting, for example, if […]
How to Write a Software Documentation Plan
October 7, 2011 By
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, requirements, costs, and deliverables. As this is for technical writers, the documentation plan will focus on the content you intent to deliver; […]
11 Adobe Distiller Tips For Technical Writers
May 16, 2010 By
Most Technical Writers use Adobe PDFs to create technical guides, reports and other business documents. And while there are many free PDF converters out there, Adobe Distiller has some great features that give you greater control of your documents, such as making the PDFs download faster, password protection, embedding thumbnails and font control.
Using Google Plus to Write Technical Documents
January 22, 2010 By
Maeve asks on LinkedIn how we can use Google Wave to write technical documents. Well, the first consideration is that Google Wave is not designed as a tech authoring tool but for collaboration and ‘almost’ real-time information exchange. Saying that, it does offer many benefits if you need to plan/coordinate/review documents in a networked environment. Here are some ideas.
Do Technical Writers need a Documentation Plan?
October 17, 2009 By
Do you review your documentation plans? This is in relation to the Documentation Plan (aka Information Development Plan) that most technical writers prepare in advance of starting a major project. Granted, on smaller projects you can get away with this if you know the product, have the resources and the deliverables are nailed down. But, […]
