“What’s New” Software Guides
End User/Intended Audience: new customers & existing customers wishing to upgrade.
During my work at TI, I produced two “What’s New” guides. These were 8-10 page documents that were released on the website whenever there was a major release.
- Code Composer Studio IDE Getting Started, v. 3.1 (PDF)
- Code Composer Studio IDE Getting Started, v. 3.2 (PDF)
These two documents provide a user-friendly view of the new features in the new software product. The aim was to make a persuasive case for upgrading.
To obtain the information for these documents, I used existing online help which I created (along with other team members) during the early phases of product development. Later, I worked with the product’s marketing team to figure out which features to emphasize and how they would benefits to the user. I drafted the original document but amended it several times during the draft phase to incorporate suggestions from reviewers.
Tools used: Initially, we used an in-house Unix-based content management system to generate PDFs. Later, my company started migrating all their documentary repositories to be XML-based, so for the second one I used the XMetal XML editor to produce structured XML content (using an in-house DTD) which later was transformed by the Astoria XML document repository into PDF content.
Keywords dsp | graphics | marketing | pdf | software | user guide | xmetal | xml