Looking for a consultant who can solve your documentation mystery and can “whip” your documentation into shape? You have come to the right place. I’m an experienced writer, editor, and formatter. I have many years of experience as a business owner, as an employee in some very large and respected companies, and as a consultant. I have seen many different documentation methods and processes. Some were excellent and some not so excellent.
The sad thing is, documentation is no different than any other business product—your product in particular. It must be tested, tested, and tested to ensure that it is clear, concise, and correct.
Your documentation is a reflection of your competency and professionalism. If the documentation is poorly written, ugly, unorganized, or incorrect your business will suffer. Customers will call you and probably not be too nice. Your technical support staff will quit!
DITA, XML, and Structured FrameMaker
I can plan a new way to process your documentation using Darwin Information Typing Architecture (DITA) and single-source content using structured FrameMaker. Are you familiar with DITA? How about single-sourcing? DITA is “an XML data model for authoring and, with the DITA Open Toolkit, publishing. It is a standard that is defined and maintained by the OASIS DITA Technical Committee.”*
DITA is a simple way to organize topics with a defined primary objective (procedure, glossary entry, troubleshooting information, etc.) and structure. You and I will establish an across-the-board standard of topics that mean something to your customers and your staff. This methodology eliminates formatting “tag” errors, finalized content overwrites—you get the idea.
What about looking at ways to reduce publishing costs and streamlining processes so that your valuable writing staff can be more productive and efficient? Single-sourcing and using DITA are the methods to use.
This is what I guarantee to you. I will always deliver clear, concise, and consistent content tailored to your branding and style. I have one mission—make your documentation an asset for your business, not a liability, by streamlining your documentation processes to reduce costs and improve customer relationships.
Remember my aim is to reduce production time and technical support calls.
Resources and Interesting Articles
- The Hitchhikers Guide to AML Authoring (Adobe)
- *Wikipedia, https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
- The Chicago Manual of Style (foremost authority on grammar and styles)
- Microsoft has its own style guide which is available for purchase on Amazon and other booksellers websites. For Amazon, go to http://www.amazon.com/Microsoft-Manual-Style-4th-Edition/dp/0735648719.
For more information, email firstname.lastname@example.org or call 949-269-7809.