Maintaining Milestones & Schedule For Technical Documentation

by Dave Jordan

This newsletter focuses on the importance of maintaining the documentation milestones and schedules for developers of hardware and software systems or products. Lets first briefly discuss a few basic principles for establishing documentation milestones with respect to the system’s development.

Read More

The Technical Writers Checklist

by Dave Jordan

Posted by: on May 11, 2016 in Technical Writing | No Comments

If you’ve read the previous newsletters, you now know the following: We thoroughly understand the task at hand.  We’ve hired the right people.  We’ve identified a Documentation Consultant to help us over the rough spots.  And we’ve established our budgeting and schedule.  NOW LET’S WRITE SOME DOCUMENTS!

Read More

MadCap Flare Part II: Trial and Tutorial Review

by Jean Fischer

Posted by: on May 10, 2016 in Technical Writing | No Comments

MadCap Flare Trial and Tutorial Review

The Flare Tutorial is an 88-page PDF file with step-by-step instructions on using MadCap Flare. Creating a project called “San Diego”, using a pre-existing template, is fairly easy. That is covered in the first 19 pages. Once you have created a project, and a topic (or snippet or master page) it will be seen within the XML Editor. All writing, formatting, and editing are done in the XML editor.

Read More

MadCap Flare Part I

by Jean Fischer

Posted by: on May 8, 2016 in Technical Writing | No Comments

Flexibility of Formats
While technical writing documents, and content can be written using many different tools which produce many different formats, MadCap Flare permits the flexibility of being able to publish content in a large variety of formats including HTML5, WebHelp, PDF, Word, XHTML, EPUB, DITA and more.It also permits importation of legacy files in those formats. It is possible to import content from other applications directly into Flare.

Read More

Is Your Technical Writer a Story Teller?

by Jean Fischer

Posted by: on Apr 12, 2016 in Technical Writing | No Comments

I was relaxing at home one evening, watching one of my favorite travel channels.  I admit it.  I live vicariously through other people’s travel adventures.  The featured trip was a river cruise in Portugal. The most I knew about Portugal was that it’s native language is Portuguese, and that the language is shared with natives of Brazil. 

Read More